Microsoft.ApiManagement (preview:2024-10-01)

2025/08/14 • 621 new methods

ApiGateway_CreateOrUpdate (new)
Description :  Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management gateway operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGateway_Update (new)
Description :  Updates an existing API Management gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management gateway operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Management gateway. ,
Required: False ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: False ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGateway_Get (new)
Description :  Gets an API Management gateway resource description.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGateway_Delete (new)
Description :  Deletes an existing API Management gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Location header ,
}
string ,
}
,
$schema:
{
Description: A single API Management gateway resource in List or Get response. ,
}
{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGateway_ListByResourceGroup (new)
Description :  List all API Management gateways within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management gateway operation. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGateway_List (new)
Description :  List all API Management gateways within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/gateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management gateway operation. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the API Management gateway. ,
Required: True ,
}
object ,
sku:
{
Description: SKU properties of the API Management gateway. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementGatewaySkus_ListAvailableSkus (new)
Description :  Gets all available SKU for a given API Management gateway
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/skus
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the gateway. ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
sku:
{
Description: Specifies API Management gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Standard: Standard SKU of the API gateway. ,
WorkspaceGatewayStandard: Standard SKU of the API gateway to be used in Workspaces. ,
WorkspaceGatewayPremium: Premium SKU of the API gateway to be used in Workspaces. ,
}
,
Required: False ,
}
enum ,
}
,
capacity:
{
Description: Specifies the number of API Management gateway units. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity that can be set. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
Automatic: Supported scale type automatic. ,
Manual: Supported scale type manual. ,
None: Scaling not supported. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of API Management gateway Skus. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AllPolicies_ListByService (new)
Description :  Status of all policies of API Management services.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/allPolicies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: AllPolicies Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the All Policies. ,
Required: False ,
}
{
referencePolicyId:
{
Description: Policy Identifier ,
Required: False ,
}
string ,
complianceState:
{
Description: Policy Restriction Compliance State ,
Enum:
{
Pending: The policy restriction compliance state has not yet been determined. ,
NonCompliant: The scope in restriction is out of compliance. ,
Compliant: The scope in restriction is in compliance. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
 ,
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 ,
tags:
{
Description: Include tags in the response. ,
Required: False ,
}
string ,
expandApiVersionSet:
{
Description: Include full ApiVersionSet resource in response ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: API entity create of update properties. ,
Required: False ,
}
{
value:
{
Description: Content value when Importing an API. ,
Required: False ,
}
string ,
format:
{
Description: Format of the Content in which the API is getting imported. New formats can be added in the future ,
Enum:
{
wadl-xml: The contents are inline and Content type is a WADL document. ,
wadl-link-json: The WADL document is hosted on a publicly accessible internet address. ,
swagger-json: The contents are inline and Content Type is a OpenAPI 2.0 JSON Document. ,
swagger-link-json: The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address. ,
wsdl: The contents are inline and the document is a WSDL/Soap document. ,
wsdl-link: The WSDL document is hosted on a publicly accessible internet address. ,
openapi: The contents are inline and Content Type is a OpenAPI 3.0 YAML Document. ,
openapi+json: The contents are inline and Content Type is a OpenAPI 3.0 JSON Document. ,
openapi-link: The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address. ,
openapi+json-link: The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address. ,
graphql-link: The GraphQL API endpoint hosted on a publicly accessible internet address. ,
odata: The contents are inline and Content Type is a OData XML Document. ,
odata-link: The OData metadata document hosted on a publicly accessible internet address. ,
grpc: The contents are inline and Content Type is a gRPC protobuf file. ,
grpc-link: The gRPC protobuf file is hosted on a publicly accessible internet address. ,
}
,
Required: False ,
}
enum ,
wsdlSelector:
{
Description: Criteria to limit import of WSDL to a subset of the document. ,
Required: False ,
}
{
wsdlServiceName:
{
Description: Name of service to import from WSDL ,
Required: False ,
}
string ,
wsdlEndpointName:
{
Description: Name of endpoint(port) to import from WSDL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: Type of API to create. * `http` creates a REST API * `soap` creates a SOAP pass-through API * `websocket` creates websocket API * `graphql` creates GraphQL API. New types can be added in the future. ,
Enum:
{
http: Imports a SOAP API having a RESTful front end. ,
soap: Imports the SOAP API having a SOAP front end. ,
websocket: Imports the API having a Websocket front end. ,
graphql: Imports the API having a GraphQL front end. ,
odata: Imports the API having a OData front end. ,
grpc: Imports the API having a gRPC front end. ,
}
,
Required: False ,
}
enum ,
translateRequiredQueryParameters:
{
Description: Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query' ,
Enum:
{
template: Translates required query parameters to template ones. Is a default value ,
query: Leaves required query parameters as they are (no translation done). ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API details. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API details. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
parameters:
{
Description: API Update Contract parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API entity that can be updated. ,
Required: False ,
}
{
displayName:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
deleteRevisions:
{
Description: Delete all revisions of the Api. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRevision_ListByService (new)
Description :  Lists all revisions of an API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
apiId:
{
Description: Identifier of the API Revision. ,
Required: False ,
}
string ,
apiRevision:
{
Description: Revision number of API. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API Revision was created. 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 ,
updatedDateTime:
{
Description: The time the API Revision were updated. 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 ,
description:
{
Description: Description of the API Revision. ,
Required: False ,
}
string ,
privateUrl:
{
Description: Gateway URL for accessing the non-current API Revision. ,
Required: False ,
}
string ,
isOnline:
{
Description: Indicates if API revision is the current api revision. ,
Required: False ,
}
boolean ,
isCurrent:
{
Description: Indicates if API revision is accessible via the gateway. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRelease_ListByService (new)
Description :  Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRelease_GetEntityTag (new)
Description :  Returns the etag of an API release.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRelease_Get (new)
Description :  Returns the details of an API release.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRelease_CreateOrUpdate (new)
Description :  Creates a new Release for the API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRelease_Update (new)
Description :  Updates the details of the release of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: API Release Update parameters. ,
Required: True ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiRelease_Delete (new)
Description :  Deletes the specified release in the API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperation_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | 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 ,
tags:
{
Description: Include tags in the response. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperation_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API operation specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperation_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperation_CreateOrUpdate (new)
Description :  Creates a new operation in the API 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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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 ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: API Operation details. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ 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. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperation_Update (new)
Description :  Updates the details of the operation in the API 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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: API Operation Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Operation entity that can be updated. ,
Required: False ,
}
{
displayName:
{
Description: Operation Name. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperation_Delete (new)
Description :  Deletes the specified operation in the API.
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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperationPolicy_ListByOperation (new)
Description :  Get the list of policy configuration at the API Operation level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperationPolicy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API operation policy specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperationPolicy_Get (new)
Description :  Get the policy configuration at the API Operation level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperationPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the API Operation level.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiOperationPolicy_Delete (new)
Description :  Deletes the policy configuration at the Api Operation.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_ListByOperation (new)
Description :  Lists all Tags associated with the Operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetEntityStateByOperation (new)
Description :  Gets the entity state version of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetByOperation (new)
Description :  Get tag associated with the Operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_AssignToOperation (new)
Description :  Assign tag to the Operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_DetachFromOperation (new)
Description :  Detach the tag from the Operation.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolver_ListByApi (new)
Description :  Lists a collection of the resolvers for the specified GraphQL API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Resolver Contract. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolver_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolver_Get (new)
Description :  Gets the details of the GraphQL API Resolver specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: GraphQL API Resolver details. ,
}
{
properties:
{
Description: Properties of the Resolver Contract. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolver_CreateOrUpdate (new)
Description :  Creates a new resolver in the GraphQL API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Resolver Contract. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: GraphQL API Resolver details. ,
}
{
properties:
{
Description: Properties of the Resolver Contract. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: GraphQL API Resolver details. ,
}
{
properties:
{
Description: Properties of the Resolver Contract. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolver_Update (new)
Description :  Updates the details of the resolver in the GraphQL API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: GraphQL API Resolver Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the GraphQL API Resolver entity that can be updated. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: GraphQL API Resolver details. ,
}
{
properties:
{
Description: Properties of the Resolver Contract. ,
Required: False ,
}
{
displayName:
{
Description: Resolver Name. ,
Required: False ,
}
string ,
path:
{
Description: Path is type/field being resolved. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resolver. May include HTML formatting tags. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolver_Delete (new)
Description :  Deletes the specified resolver in the GraphQL API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolverPolicy_ListByResolver (new)
Description :  Get the list of policy configuration at the GraphQL API Resolver level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolverPolicy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolverPolicy_Get (new)
Description :  Get the policy configuration at the GraphQL API Resolver level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolverPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the GraphQL API Resolver level.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GraphQLApiResolverPolicy_Delete (new)
Description :  Deletes the policy configuration at the GraphQL Api Resolver.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
resolverId:
{
Description: Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiProduct_ListByApis (new)
Description :  Lists all Products, which the API is part of.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiPolicy_ListByApi (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiPolicy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API policy specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiPolicy_Get (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiPolicy_Delete (new)
Description :  Deletes the policy configuration at the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiSchema_ListByApi (new)
Description :  Get the schema configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: API Schema Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiSchema_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the schema specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiSchema_Get (new)
Description :  Get the schema configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Schema Contract details. ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiSchema_CreateOrUpdate (new)
Description :  Creates or updates schema configuration for the API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: The schema contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API Schema Contract details. ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API Schema Contract details. ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiSchema_Delete (new)
Description :  Deletes the schema configuration at the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
force:
{
Description: If true removes all references to the schema before deleting it. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiDiagnostic_ListByService (new)
Description :  Lists all diagnostics of an API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiDiagnostic_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiDiagnostic_Get (new)
Description :  Gets the details of the Diagnostic for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiDiagnostic_CreateOrUpdate (new)
Description :  Creates a new Diagnostic for an API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiDiagnostic_Update (new)
Description :  Updates the details of the Diagnostic for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Diagnostic Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiDiagnostic_Delete (new)
Description :  Deletes the specified Diagnostic from an API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssue_ListByService (new)
Description :  Lists all issues associated with the specified API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
 ,
Required: False ,
}
string ,
expandCommentsAttachments:
{
Description: Expand the comment attachments. ,
Required: False ,
}
boolean ,
$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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Issue values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssue_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssue_Get (new)
Description :  Gets the details of the Issue for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
expandCommentsAttachments:
{
Description: Expand the comment attachments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Issue Contract details. ,
}
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssue_CreateOrUpdate (new)
Description :  Creates a new Issue for an API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Issue Contract details. ,
}
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
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: Issue Contract details. ,
}
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssue_Update (new)
Description :  Updates an existing issue for an API.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Issue entity Update contract properties. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: False ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: False ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Issue Contract details. ,
}
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssue_Delete (new)
Description :  Deletes the specified Issue from an API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueComment_ListByService (new)
Description :  Lists all comments for the Issue associated with the specified API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Issue Comment values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Issue Comment. ,
Required: False ,
}
{
text:
{
Description: Comment text. ,
Required: True ,
}
string ,
createdDate:
{
Description: Date and time when the comment was created. ,
Format: date-time ,
Required: False ,
}
string ,
userId:
{
Description: A resource identifier for the user who left the comment. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueComment_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
commentId:
{
Description: Comment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueComment_Get (new)
Description :  Gets the details of the issue Comment for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
commentId:
{
Description: Comment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Issue Comment Contract details. ,
}
{
properties:
{
Description: Properties of the Issue Comment. ,
Required: False ,
}
{
text:
{
Description: Comment text. ,
Required: True ,
}
string ,
createdDate:
{
Description: Date and time when the comment was created. ,
Format: date-time ,
Required: False ,
}
string ,
userId:
{
Description: A resource identifier for the user who left the comment. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueComment_CreateOrUpdate (new)
Description :  Creates a new Comment for the Issue in an API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
commentId:
{
Description: Comment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Issue Comment. ,
Required: False ,
}
{
text:
{
Description: Comment text. ,
Required: True ,
}
string ,
createdDate:
{
Description: Date and time when the comment was created. ,
Format: date-time ,
Required: False ,
}
string ,
userId:
{
Description: A resource identifier for the user who left the comment. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Issue Comment Contract details. ,
}
{
properties:
{
Description: Properties of the Issue Comment. ,
Required: False ,
}
{
text:
{
Description: Comment text. ,
Required: True ,
}
string ,
createdDate:
{
Description: Date and time when the comment was created. ,
Format: date-time ,
Required: False ,
}
string ,
userId:
{
Description: A resource identifier for the user who left the comment. ,
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: Issue Comment Contract details. ,
}
{
properties:
{
Description: Properties of the Issue Comment. ,
Required: False ,
}
{
text:
{
Description: Comment text. ,
Required: True ,
}
string ,
createdDate:
{
Description: Date and time when the comment was created. ,
Format: date-time ,
Required: False ,
}
string ,
userId:
{
Description: A resource identifier for the user who left the comment. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueComment_Delete (new)
Description :  Deletes the specified comment from an Issue.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
commentId:
{
Description: Comment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueAttachment_ListByService (new)
Description :  Lists all attachments for the Issue associated with the specified API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Issue Attachment values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Issue Attachment. ,
Required: False ,
}
{
title:
{
Description: Filename by which the binary data will be saved. ,
Required: True ,
}
string ,
contentFormat:
{
Description: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. ,
Required: True ,
}
string ,
content:
{
Description: An HTTP link or Base64-encoded binary data. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueAttachment_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Attachment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueAttachment_Get (new)
Description :  Gets the details of the issue Attachment for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Attachment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Issue Attachment Contract details. ,
}
{
properties:
{
Description: Properties of the Issue Attachment. ,
Required: False ,
}
{
title:
{
Description: Filename by which the binary data will be saved. ,
Required: True ,
}
string ,
contentFormat:
{
Description: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. ,
Required: True ,
}
string ,
content:
{
Description: An HTTP link or Base64-encoded binary data. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueAttachment_CreateOrUpdate (new)
Description :  Creates a new Attachment for the Issue in an API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Attachment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Issue Attachment. ,
Required: False ,
}
{
title:
{
Description: Filename by which the binary data will be saved. ,
Required: True ,
}
string ,
contentFormat:
{
Description: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. ,
Required: True ,
}
string ,
content:
{
Description: An HTTP link or Base64-encoded binary data. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Issue Attachment Contract details. ,
}
{
properties:
{
Description: Properties of the Issue Attachment. ,
Required: False ,
}
{
title:
{
Description: Filename by which the binary data will be saved. ,
Required: True ,
}
string ,
contentFormat:
{
Description: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. ,
Required: True ,
}
string ,
content:
{
Description: An HTTP link or Base64-encoded binary data. ,
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: Issue Attachment Contract details. ,
}
{
properties:
{
Description: Properties of the Issue Attachment. ,
Required: False ,
}
{
title:
{
Description: Filename by which the binary data will be saved. ,
Required: True ,
}
string ,
contentFormat:
{
Description: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. ,
Required: True ,
}
string ,
content:
{
Description: An HTTP link or Base64-encoded binary data. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiIssueAttachment_Delete (new)
Description :  Deletes the specified comment from an Issue.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Attachment identifier within an Issue. Must be unique in the current Issue. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiTagDescription_ListByService (new)
Description :  Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: TagDescription entity contract properties. ,
Required: False ,
}
{
tagId:
{
Description: Identifier of the tag in the form of /tags/{tagId} ,
Required: False ,
}
string ,
displayName:
{
Description: Tag name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiTagDescription_GetEntityTag (new)
Description :  Gets the entity state version of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagDescriptionId:
{
Description: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiTagDescription_Get (new)
Description :  Get Tag description in scope of API
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagDescriptionId:
{
Description: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: TagDescription entity contract properties. ,
Required: False ,
}
{
tagId:
{
Description: Identifier of the tag in the form of /tags/{tagId} ,
Required: False ,
}
string ,
displayName:
{
Description: Tag name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiTagDescription_CreateOrUpdate (new)
Description :  Create/Update tag description in scope of the Api.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagDescriptionId:
{
Description: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to Create TagDescription operation. ,
Required: False ,
}
{
description:
{
Description: Description of the Tag. ,
Required: False ,
}
string ,
externalDocsUrl:
{
Description: Absolute URL of external resources describing the tag. ,
Required: False ,
}
string ,
externalDocsDescription:
{
Description: Description of the external resources describing the tag. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: TagDescription entity contract properties. ,
Required: False ,
}
{
tagId:
{
Description: Identifier of the tag in the form of /tags/{tagId} ,
Required: False ,
}
string ,
displayName:
{
Description: Tag name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: TagDescription entity contract properties. ,
Required: False ,
}
{
tagId:
{
Description: Identifier of the tag in the form of /tags/{tagId} ,
Required: False ,
}
string ,
displayName:
{
Description: Tag name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiTagDescription_Delete (new)
Description :  Delete tag description for the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagDescriptionId:
{
Description: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_ListByApi (new)
Description :  Lists all Tags associated with the API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetEntityStateByApi (new)
Description :  Gets the entity state version of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetByApi (new)
Description :  Get tag associated with the API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_AssignToApi (new)
Description :  Assign tag to the Api.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_DetachFromApi (new)
Description :  Detach the tag from the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operation_ListByTags (new)
Description :  Lists a collection of operations associated with tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | 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 ,
includeNotTaggedOperations:
{
Description: Include not tagged Operations. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
tag:
{
Description: Tag associated with the resource. ,
Required: True ,
}
{
id:
{
Description: Tag identifier ,
Required: False ,
}
string ,
name:
{
Description: Tag Name ,
Required: False ,
}
string ,
}
,
api:
{
Description: API associated with the tag. ,
Required: False ,
}
{
id:
{
Description: API identifier in the form /apis/{apiId}. ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
operation:
{
Description: Operation associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the operation in form /operations/{operationId}. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
apiName:
{
Description: API Name. ,
Required: False ,
}
string ,
apiRevision:
{
Description: API Revision. ,
Required: False ,
}
string ,
apiVersion:
{
Description: API Version. ,
Required: False ,
}
string ,
description:
{
Description: Operation Description. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
product:
{
Description: Product associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the product in the form of /products/{productId} ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiWiki_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiWiki_Get (new)
Description :  Gets the details of the Wiki for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiWiki_CreateOrUpdate (new)
Description :  Creates a new Wiki for an API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 parameters. ,
Required: True ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiWiki_Update (new)
Description :  Updates the details of the Wiki for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: Wiki Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiWiki_Delete (new)
Description :  Deletes the specified Wiki from an API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiWikis_List (new)
Description :  Gets the wikis for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Api_ListByTags (new)
Description :  Lists a collection of apis associated with tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | 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 ,
includeNotTaggedApis:
{
Description: Include not tagged APIs. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
tag:
{
Description: Tag associated with the resource. ,
Required: True ,
}
{
id:
{
Description: Tag identifier ,
Required: False ,
}
string ,
name:
{
Description: Tag Name ,
Required: False ,
}
string ,
}
,
api:
{
Description: API associated with the tag. ,
Required: False ,
}
{
id:
{
Description: API identifier in the form /apis/{apiId}. ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
operation:
{
Description: Operation associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the operation in form /operations/{operationId}. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
apiName:
{
Description: API Name. ,
Required: False ,
}
string ,
apiRevision:
{
Description: API Revision. ,
Required: False ,
}
string ,
apiVersion:
{
Description: API Version. ,
Required: False ,
}
string ,
description:
{
Description: Operation Description. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
product:
{
Description: Product associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the product in the form of /products/{productId} ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiVersionSet_ListByService (new)
Description :  Lists a collection of API Version Sets in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiVersionSet_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Api Version Set specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiVersionSet_Get (new)
Description :  Gets the details of the Api Version Set specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiVersionSet_CreateOrUpdate (new)
Description :  Creates or Updates a Api Version Set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: API Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ 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 Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiVersionSet_Update (new)
Description :  Updates the details of the Api VersionSet specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Parameters to update or create an API Version Set Contract. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiVersionSet_Delete (new)
Description :  Deletes specific Api Version Set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationProvider_ListByService (new)
Description :  Lists a collection of authorization providers defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Authorization Provider Contract. ,
Required: False ,
}
{
displayName:
{
Description: Authorization Provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
identityProvider:
{
Description: Identity provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
oauth2:
{
Description: OAuth2 settings ,
Required: False ,
}
{
redirectUrl:
{
Description: Redirect URL to be set in the OAuth application. ,
Required: False ,
}
string ,
grantTypes:
{
Description: OAuth2 settings ,
Required: False ,
}
{
authorizationCode:
{
Description: OAuth2 authorization code grant parameters ,
Required: False ,
}
object ,
clientCredentials:
{
Description: OAuth2 client credential grant parameters ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationProvider_Get (new)
Description :  Gets the details of the authorization provider specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Authorization Provider contract. ,
}
{
properties:
{
Description: Properties of the Authorization Provider Contract. ,
Required: False ,
}
{
displayName:
{
Description: Authorization Provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
identityProvider:
{
Description: Identity provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
oauth2:
{
Description: OAuth2 settings ,
Required: False ,
}
{
redirectUrl:
{
Description: Redirect URL to be set in the OAuth application. ,
Required: False ,
}
string ,
grantTypes:
{
Description: OAuth2 settings ,
Required: False ,
}
{
authorizationCode:
{
Description: OAuth2 authorization code grant parameters ,
Required: False ,
}
object ,
clientCredentials:
{
Description: OAuth2 client credential grant parameters ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationProvider_CreateOrUpdate (new)
Description :  Creates or updates authorization provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Authorization Provider Contract. ,
Required: False ,
}
{
displayName:
{
Description: Authorization Provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
identityProvider:
{
Description: Identity provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
oauth2:
{
Description: OAuth2 settings ,
Required: False ,
}
{
redirectUrl:
{
Description: Redirect URL to be set in the OAuth application. ,
Required: False ,
}
string ,
grantTypes:
{
Description: OAuth2 settings ,
Required: False ,
}
{
authorizationCode:
{
Description: OAuth2 authorization code grant parameters ,
Required: False ,
}
object ,
clientCredentials:
{
Description: OAuth2 client credential grant parameters ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Authorization Provider contract. ,
}
{
properties:
{
Description: Properties of the Authorization Provider Contract. ,
Required: False ,
}
{
displayName:
{
Description: Authorization Provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
identityProvider:
{
Description: Identity provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
oauth2:
{
Description: OAuth2 settings ,
Required: False ,
}
{
redirectUrl:
{
Description: Redirect URL to be set in the OAuth application. ,
Required: False ,
}
string ,
grantTypes:
{
Description: OAuth2 settings ,
Required: False ,
}
{
authorizationCode:
{
Description: OAuth2 authorization code grant parameters ,
Required: False ,
}
object ,
clientCredentials:
{
Description: OAuth2 client credential grant parameters ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Authorization Provider contract. ,
}
{
properties:
{
Description: Properties of the Authorization Provider Contract. ,
Required: False ,
}
{
displayName:
{
Description: Authorization Provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
identityProvider:
{
Description: Identity provider name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
oauth2:
{
Description: OAuth2 settings ,
Required: False ,
}
{
redirectUrl:
{
Description: Redirect URL to be set in the OAuth application. ,
Required: False ,
}
string ,
grantTypes:
{
Description: OAuth2 settings ,
Required: False ,
}
{
authorizationCode:
{
Description: OAuth2 authorization code grant parameters ,
Required: False ,
}
object ,
clientCredentials:
{
Description: OAuth2 client credential grant parameters ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationProvider_Delete (new)
Description :  Deletes specific authorization provider from the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorization_ListByAuthorizationProvider (new)
Description :  Lists a collection of authorization providers defined within a authorization provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
authorizationType:
{
Description: Authorization type options ,
Enum:
{
OAuth2: OAuth2 authorization type ,
}
,
Required: False ,
}
enum ,
oauth2grantType:
{
Description: OAuth2 grant type options ,
Enum:
{
AuthorizationCode: Authorization Code grant ,
ClientCredentials: Client Credential grant ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Authorization parameters ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the Authorization ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorization_Get (new)
Description :  Gets the details of the authorization specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Authorization contract. ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
authorizationType:
{
Description: Authorization type options ,
Enum:
{
OAuth2: OAuth2 authorization type ,
}
,
Required: False ,
}
enum ,
oauth2grantType:
{
Description: OAuth2 grant type options ,
Enum:
{
AuthorizationCode: Authorization Code grant ,
ClientCredentials: Client Credential grant ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Authorization parameters ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the Authorization ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorization_CreateOrUpdate (new)
Description :  Creates or updates authorization.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
authorizationType:
{
Description: Authorization type options ,
Enum:
{
OAuth2: OAuth2 authorization type ,
}
,
Required: False ,
}
enum ,
oauth2grantType:
{
Description: OAuth2 grant type options ,
Enum:
{
AuthorizationCode: Authorization Code grant ,
ClientCredentials: Client Credential grant ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Authorization parameters ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the Authorization ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Authorization contract. ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
authorizationType:
{
Description: Authorization type options ,
Enum:
{
OAuth2: OAuth2 authorization type ,
}
,
Required: False ,
}
enum ,
oauth2grantType:
{
Description: OAuth2 grant type options ,
Enum:
{
AuthorizationCode: Authorization Code grant ,
ClientCredentials: Client Credential grant ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Authorization parameters ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the Authorization ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Authorization contract. ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
authorizationType:
{
Description: Authorization type options ,
Enum:
{
OAuth2: OAuth2 authorization type ,
}
,
Required: False ,
}
enum ,
oauth2grantType:
{
Description: OAuth2 grant type options ,
Enum:
{
AuthorizationCode: Authorization Code grant ,
ClientCredentials: Client Credential grant ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Authorization parameters ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the Authorization ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorization_Delete (new)
Description :  Deletes specific Authorization from the Authorization provider.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationLoginLinks_Post (new)
Description :  Gets authorization login links.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/getLoginLinks
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
postLoginRedirectUrl:
{
Description: The redirect URL after login has completed. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Authorization login response contract. ,
}
{
loginLink:
{
Description: The login link ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorization_ConfirmConsentCode (new)
Description :  Confirm valid consent code to suppress Authorizations anti-phishing page.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/confirmConsentCode
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
consentCode:
{
Description: The consent code from the authorization server after authorizing and consenting. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationAccessPolicy_ListByAuthorization (new)
Description :  Lists a collection of authorization access policy defined within a authorization.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
appIds:
{
Description: The allowed Azure Active Directory Application IDs ,
Required: False ,
}
[
string ,
]
,
tenantId:
{
Description: The Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: The Object Id ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationAccessPolicy_Get (new)
Description :  Gets the details of the authorization access policy specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
authorizationAccessPolicyId:
{
Description: Identifier of the authorization access policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Authorization access policy contract. ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
appIds:
{
Description: The allowed Azure Active Directory Application IDs ,
Required: False ,
}
[
string ,
]
,
tenantId:
{
Description: The Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: The Object Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationAccessPolicy_CreateOrUpdate (new)
Description :  Creates or updates Authorization Access Policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
authorizationAccessPolicyId:
{
Description: Identifier of the authorization access policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
appIds:
{
Description: The allowed Azure Active Directory Application IDs ,
Required: False ,
}
[
string ,
]
,
tenantId:
{
Description: The Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: The Object Id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Authorization access policy contract. ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
appIds:
{
Description: The allowed Azure Active Directory Application IDs ,
Required: False ,
}
[
string ,
]
,
tenantId:
{
Description: The Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: The Object Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Authorization access policy contract. ,
}
{
properties:
{
Description: Properties of the Authorization Contract. ,
Required: False ,
}
{
appIds:
{
Description: The allowed Azure Active Directory Application IDs ,
Required: False ,
}
[
string ,
]
,
tenantId:
{
Description: The Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: The Object Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationAccessPolicy_Delete (new)
Description :  Deletes specific access policy from the Authorization.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authorizationProviderId:
{
Description: Identifier of the authorization provider. ,
Required: True ,
}
string ,
authorizationId:
{
Description: Identifier of the authorization. ,
Required: True ,
}
string ,
authorizationAccessPolicyId:
{
Description: Identifier of the authorization access policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the External OAuth authorization server Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
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 ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the authorizationServer specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_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. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Properties of the External OAuth authorization server Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
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 ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Properties of the External OAuth authorization server Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
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 ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: External OAuth authorization server settings. ,
}
{
properties:
{
Description: Properties of the External OAuth authorization server Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
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 ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: External OAuth authorization server settings. ,
}
{
properties:
{
Description: Properties of the External OAuth authorization server Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
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 ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Properties of the External OAuth authorization server update Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: False ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
clientRegistrationEndpoint:
{
Description: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. ,
Required: False ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Properties of the External OAuth authorization server Contract. ,
Required: False ,
}
{
displayName:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
useInTestConsole:
{
Description: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
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 ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_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. The name is case insensitive. ,
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: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizationServer_ListSecrets (new)
Description :  Gets the client secret details of the authorization server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: OAuth Server Secrets Contract. ,
}
{
clientSecret:
{
Description: oAuth Authorization Server Secrets. ,
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Backend values. ,
Required: False ,
}
[
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the backend specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Backend entity update contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backend_Reconnect (new)
Description :  Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Reconnect request parameters. ,
Required: False ,
}
{
properties:
{
Description: Reconnect request properties. ,
Required: False ,
}
{
after:
{
Description: Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cache_ListByService (new)
Description :  Lists a collection of all external Caches in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Cache properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: True ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: True ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cache_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Cache specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
cacheId:
{
Description: Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cache_Get (new)
Description :  Gets the details of the Cache specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
cacheId:
{
Description: Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Cache details. ,
}
{
properties:
{
Description: Cache properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: True ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: True ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cache_CreateOrUpdate (new)
Description :  Creates or updates an External Cache to be used in Api Management instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
cacheId:
{
Description: Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). ,
Required: True ,
}
string ,
parameters:
{
Description: Create or Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Cache properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: True ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: True ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Cache details. ,
}
{
properties:
{
Description: Cache properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: True ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: True ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Cache details. ,
}
{
properties:
{
Description: Cache properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: True ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: True ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cache_Update (new)
Description :  Updates the details of the cache specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
cacheId:
{
Description: Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Cache update properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: False ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: False ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Cache details. ,
}
{
properties:
{
Description: Cache properties details. ,
Required: False ,
}
{
description:
{
Description: Cache description ,
Required: False ,
}
string ,
connectionString:
{
Description: Runtime connection string to cache ,
Required: True ,
}
string ,
useFromLocation:
{
Description: Location identifier to use cache from (should be either 'default' or valid Azure region identifier) ,
Required: True ,
}
string ,
resourceId:
{
Description: Original uri of entity in external system cache points to ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Cache_Delete (new)
Description :  Deletes specific Cache.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
cacheId:
{
Description: Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificate_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
 ,
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 ,
isKeyVaultRefreshFailed:
{
Description: When set to true, the response contains only certificates entities which failed refresh. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificate_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the certificate specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificate_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. The name is case insensitive. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificate_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. The name is case insensitive. ,
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 or Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Certificate create or update properties details. ,
Required: False ,
}
{
data:
{
Description: Base 64 encoded certificate using the application/x-pkcs12 representation. ,
Required: False ,
}
string ,
password:
{
Description: Password for the Certificate ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
secretIdentifier:
{
Description: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi ,
Required: False ,
}
string ,
identityClientId:
{
Description: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Certificate details. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ 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. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificate_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. The name is case insensitive. ,
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 ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificate_RefreshSecret (new)
Description :  From KeyVault, Refresh the certificate being used for authentication with the backend.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientApplication_ListByService (new)
Description :  Lists a collection of client applications in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
state | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Client application entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Client application name. ,
Required: True ,
}
string ,
description:
{
Description: Client application description. ,
Required: False ,
}
string ,
ownerId:
{
Description: A resource identifier for the user who owns the application. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created. ,
Required: False ,
}
string ,
entraTenantId:
{
Description: Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services. ,
Required: False ,
}
string ,
state:
{
Description: Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. ,
Enum:
{
pending: If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved). ,
active: If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active ,
rejected: If all ClientApplicationLinks are rejected, the Application is considered rejected ,
approved: If at least one ClientApplicationLink is approved, the Application is considered approved ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientApplication_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the product specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
clientApplicationId:
{
Description: Client Application identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientApplication_Get (new)
Description :  Gets the details of the client application specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
clientApplicationId:
{
Description: Client Application identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Client application details. ,
}
{
properties:
{
Description: Client application entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Client application name. ,
Required: True ,
}
string ,
description:
{
Description: Client application description. ,
Required: False ,
}
string ,
ownerId:
{
Description: A resource identifier for the user who owns the application. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created. ,
Required: False ,
}
string ,
entraTenantId:
{
Description: Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services. ,
Required: False ,
}
string ,
state:
{
Description: Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. ,
Enum:
{
pending: If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved). ,
active: If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active ,
rejected: If all ClientApplicationLinks are rejected, the Application is considered rejected ,
approved: If at least one ClientApplicationLink is approved, the Application is considered approved ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientApplication_CreateOrUpdate (new)
Description :  Creates or Updates a client application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
clientApplicationId:
{
Description: Client Application identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Client application entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Client application name. ,
Required: True ,
}
string ,
description:
{
Description: Client application description. ,
Required: False ,
}
string ,
ownerId:
{
Description: A resource identifier for the user who owns the application. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created. ,
Required: False ,
}
string ,
entraTenantId:
{
Description: Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services. ,
Required: False ,
}
string ,
state:
{
Description: Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. ,
Enum:
{
pending: If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved). ,
active: If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active ,
rejected: If all ClientApplicationLinks are rejected, the Application is considered rejected ,
approved: If at least one ClientApplicationLink is approved, the Application is considered approved ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Client application details. ,
}
{
properties:
{
Description: Client application entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Client application name. ,
Required: True ,
}
string ,
description:
{
Description: Client application description. ,
Required: False ,
}
string ,
ownerId:
{
Description: A resource identifier for the user who owns the application. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created. ,
Required: False ,
}
string ,
entraTenantId:
{
Description: Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services. ,
Required: False ,
}
string ,
state:
{
Description: Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. ,
Enum:
{
pending: If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved). ,
active: If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active ,
rejected: If all ClientApplicationLinks are rejected, the Application is considered rejected ,
approved: If at least one ClientApplicationLink is approved, the Application is considered approved ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Client application details. ,
}
{
properties:
{
Description: Client application entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Client application name. ,
Required: True ,
}
string ,
description:
{
Description: Client application description. ,
Required: False ,
}
string ,
ownerId:
{
Description: A resource identifier for the user who owns the application. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created. ,
Required: False ,
}
string ,
entraTenantId:
{
Description: Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services. ,
Required: False ,
}
string ,
state:
{
Description: Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. ,
Enum:
{
pending: If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved). ,
active: If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active ,
rejected: If all ClientApplicationLinks are rejected, the Application is considered rejected ,
approved: If at least one ClientApplicationLink is approved, the Application is considered approved ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientApplication_Delete (new)
Description :  Delete client application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
clientApplicationId:
{
Description: Client Application identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClientApplication_ListSecrets (new)
Description :  Retrived client application secrets.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
clientApplicationId:
{
Description: Client Application identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
entra:
{
Description: Microsoft EntraID client application secrets ,
Required: False ,
}
{
clientSecret:
{
Description: EntraID client application secret ,
Required: False ,
}
string ,
expiresAt:
{
Description: EntraID client application secret expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PerformConnectivityCheckAsync (new)
Description :  Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
connectivityCheckRequestParams:
{
Description: Connectivity Check request parameters. ,
Required: True ,
}
{
source:
{
Description: Definitions about the connectivity check origin. ,
Required: True ,
}
{
region:
{
Description: The API Management service region from where to start the connectivity check operation. ,
Required: True ,
}
string ,
instance:
{
Description: The particular VMSS instance from which to fire the request. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
destination:
{
Description: The connectivity check operation destination. ,
Required: True ,
}
{
address:
{
Description: Destination address. Can either be an IP address or a FQDN. ,
Required: True ,
}
string ,
port:
{
Description: Destination port. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
preferredIPVersion:
{
Description: The IP version to be used. Only IPv4 is supported for now. ,
Enum:
{
IPv4: No description available. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value. ,
Enum:
{
TCP: No description available. ,
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
protocolConfiguration:
{
Description: Protocol-specific configuration. ,
Required: False ,
}
{
HTTPConfiguration:
{
Description: Configuration for HTTP or HTTPS requests. ,
Required: False ,
}
{
method:
{
Description: The HTTP method to be used. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
validStatusCodes:
{
Description: List of HTTP status codes considered valid for the request response. ,
Required: False ,
}
[
integer ,
]
,
headers:
{
Description: List of headers to be included in the request. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: True ,
}
string ,
value:
{
Description: Header value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (200)

{
hops:
{
Description: List of hops between the source and the destination. ,
Required: False ,
}
[
{
type:
{
Description: The type of the hop. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the hop. ,
Required: False ,
}
string ,
address:
{
Description: The IP address of the hop. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource corresponding to this hop. ,
Required: False ,
}
string ,
nextHopIds:
{
Description: List of next hop identifiers. ,
Required: False ,
}
[
string ,
]
,
issues:
{
Description: List of issues. ,
Required: False ,
}
[
{
origin:
{
Description: The origin of the issue. ,
Enum:
{
Local: No description available. ,
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: The severity of the issue. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of issue. ,
Enum:
{
Unknown: No description available. ,
AgentStopped: No description available. ,
GuestFirewall: No description available. ,
DnsResolution: No description available. ,
SocketBind: No description available. ,
NetworkSecurityRule: No description available. ,
UserDefinedRoute: No description available. ,
PortThrottled: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
context:
{
Description: Provides additional context on the issue. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
}
,
]
,
connectionStatus:
{
Description: The connection status. ,
Enum:
{
Unknown: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Degraded: No description available. ,
}
,
Required: False ,
}
enum ,
avgLatencyInMs:
{
Description: Average latency in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
minLatencyInMs:
{
Description: Minimum latency in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
maxLatencyInMs:
{
Description: Maximum latency in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
probesSent:
{
Description: Total number of probes sent. ,
Format: int64 ,
Required: False ,
}
integer ,
probesFailed:
{
Description: Number of failed probes. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentType_ListByService (new)
Description :  Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of content types. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the content type. ,
Required: False ,
}
{
id:
{
Description: Content type identifier ,
Required: False ,
}
string ,
name:
{
Description: Content type name. Must be 1 to 250 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Content type description. ,
Required: False ,
}
string ,
schema:
{
Description: Content type schema. ,
Required: False ,
}
object ,
version:
{
Description: Content type version. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentType_Get (new)
Description :  Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Content type contract details. ,
}
{
properties:
{
Description: Properties of the content type. ,
Required: False ,
}
{
id:
{
Description: Content type identifier ,
Required: False ,
}
string ,
name:
{
Description: Content type name. Must be 1 to 250 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Content type description. ,
Required: False ,
}
string ,
schema:
{
Description: Content type schema. ,
Required: False ,
}
object ,
version:
{
Description: Content type version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentType_CreateOrUpdate (new)
Description :  Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the content type. ,
Required: False ,
}
{
id:
{
Description: Content type identifier ,
Required: False ,
}
string ,
name:
{
Description: Content type name. Must be 1 to 250 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Content type description. ,
Required: False ,
}
string ,
schema:
{
Description: Content type schema. ,
Required: False ,
}
object ,
version:
{
Description: Content type version. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Content type contract details. ,
}
{
properties:
{
Description: Properties of the content type. ,
Required: False ,
}
{
id:
{
Description: Content type identifier ,
Required: False ,
}
string ,
name:
{
Description: Content type name. Must be 1 to 250 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Content type description. ,
Required: False ,
}
string ,
schema:
{
Description: Content type schema. ,
Required: False ,
}
object ,
version:
{
Description: Content type version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Content type contract details. ,
}
{
properties:
{
Description: Properties of the content type. ,
Required: False ,
}
{
id:
{
Description: Content type identifier ,
Required: False ,
}
string ,
name:
{
Description: Content type name. Must be 1 to 250 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Content type description. ,
Required: False ,
}
string ,
schema:
{
Description: Content type schema. ,
Required: False ,
}
object ,
version:
{
Description: Content type version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentType_Delete (new)
Description :  Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentItem_ListByService (new)
Description :  Lists developer portal's content items specified by the provided content type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of content items. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the content item. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Next page link, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentItem_GetEntityTag (new)
Description :  Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
contentItemId:
{
Description: Content item identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentItem_Get (new)
Description :  Returns the developer portal's content item specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
contentItemId:
{
Description: Content item identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Content type contract details. ,
}
{
properties:
{
Description: Properties of the content item. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentItem_CreateOrUpdate (new)
Description :  Creates a new developer portal's content item specified by the provided content type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
contentItemId:
{
Description: Content item identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the content item. ,
Required: False ,
}
object ,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Content type contract details. ,
}
{
properties:
{
Description: Properties of the content item. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Content type contract details. ,
}
{
properties:
{
Description: Properties of the content item. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContentItem_Delete (new)
Description :  Removes the specified developer portal's content item.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
contentTypeId:
{
Description: Content type identifier. ,
Required: True ,
}
string ,
contentItemId:
{
Description: Content item identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServices_ListBySubscription (new)
Description :  Lists all soft-deleted services available for undelete for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/deletedservices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Deleted API Management Service details. ,
Required: False ,
}
{
serviceId:
{
Description: Fully-qualified API Management Service Resource ID ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: UTC Date and Time when the service will be automatically purged. 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 ,
deletionDate:
{
Description: UTC Timestamp when the service was soft-deleted. 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 ,
}
,
location:
{
Description: API Management Service Master Location. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServices_GetByName (new)
Description :  Get soft-deleted Api Management Service by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}
{
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The location of the deleted API Management service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Deleted API Management Service details. ,
Required: False ,
}
{
serviceId:
{
Description: Fully-qualified API Management Service Resource ID ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: UTC Date and Time when the service will be automatically purged. 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 ,
deletionDate:
{
Description: UTC Timestamp when the service was soft-deleted. 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 ,
}
,
location:
{
Description: API Management Service Master Location. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServices_Purge (new)
Description :  Purges Api Management Service (deletes it with no option to undelete).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}
{
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The location of the deleted API Management service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Deleted API Management Service information. ,
}
{
properties:
{
Description: Deleted API Management Service details. ,
Required: False ,
}
{
serviceId:
{
Description: Fully-qualified API Management Service Resource ID ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: UTC Date and Time when the service will be automatically purged. 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 ,
deletionDate:
{
Description: UTC Timestamp when the service was soft-deleted. 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 ,
}
,
location:
{
Description: API Management Service Master Location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementOperations_List (new)
Description :  Lists all of the available REST API operations of the Microsoft.ApiManagement provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ApiManagement/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
description:
{
Description: Friendly name of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The operation origin. ,
Required: False ,
}
string ,
properties:
{
Description: The operation properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementServiceSkus_ListAvailableServiceSkus (new)
Description :  Gets all available SKU for a given API Management service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the service. ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
sku:
{
Description: Specifies API Management SKU. ,
Required: False ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: False ,
}
enum ,
}
,
capacity:
{
Description: Specifies the number of API Management units. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity that can be set. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
automatic: Supported scale type automatic. ,
manual: Supported scale type manual. ,
none: Scaling not supported. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of API Management service Skus. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_Restore (new)
Description :  Restores a backup of an API Management service created using the ApiManagementService_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. The name is case insensitive. ,
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: The name of the Azure storage account (used to place/retrieve the backup). ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the blob container (used to place/retrieve the backup). ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup file to create/retrieve. ,
Required: True ,
}
string ,
accessType:
{
Description: The type of access to be used for the storage account. ,
Enum:
{
AccessKey: Use access key. ,
SystemAssignedManagedIdentity: Use system assigned managed identity. ,
UserAssignedManagedIdentity: Use user assigned managed identity. ,
}
,
Required: False ,
}
enum ,
accessKey:
{
Description: Storage account access key. Required only if `accessType` is set to `AccessKey`. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the ApiManagementService_Backup operation. ,
Required: True ,
}
{
storageAccount:
{
Description: The name of the Azure storage account (used to place/retrieve the backup). ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the blob container (used to place/retrieve the backup). ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup file to create/retrieve. ,
Required: True ,
}
string ,
accessType:
{
Description: The type of access to be used for the storage account. ,
Enum:
{
AccessKey: Use access key. ,
SystemAssignedManagedIdentity: Use system assigned managed identity. ,
UserAssignedManagedIdentity: Use user assigned managed identity. ,
}
,
Required: False ,
}
enum ,
accessKey:
{
Description: Storage account access key. Required only if `accessType` is set to `AccessKey`. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Properties of the API Management service. ,
Required: False ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: False ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: False ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Location header ,
}
string ,
}
,
$schema:
{
Description: A single API Management service resource in List or Get response. ,
}
{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_MigrateToStv2 (new)
Description :  Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. 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}/migrateToStv2
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Optional parameters supplied to migrate service. ,
Required: False ,
}
{
mode:
{
Description: Mode of Migration to stv2. Default is PreserveIp. ,
Enum:
{
PreserveIp: Migrate API Management service to stv2 from stv1, by reserving the IP Address of the service. This will have a downtime of upto 15 minutes, while the IP address is getting migrate to new infrastructure. ,
NewIP: Migrate API Management service to stv2 from stv1. This will have no downtime as the service configuration will be migrated to new infrastructure, but the IP address will changed. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management services operation. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management services operation. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_GetSsoToken (new)
Description :  Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
redirectUri:
{
Description: Redirect URL to the Publisher Portal containing the SSO token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: False ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_GetDomainOwnershipIdentifier (new)
Description :  Get the custom domain ownership identifier for an API Management service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
domainOwnershipIdentifier:
{
Description: The domain ownership identifier value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementService_ApplyNetworkConfigurationUpdates (new)
Description :  Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region. ,
Required: False ,
}
{
location:
{
Description: Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management service. ,
Required: True ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: True ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: Developer SKU of Api Management. ,
Standard: Standard SKU of Api Management. ,
Premium: Premium SKU of Api Management. ,
Basic: Basic SKU of Api Management. ,
Consumption: Consumption SKU of Api Management. ,
Isolated: Isolated SKU of Api Management. ,
BasicV2: BasicV2 SKU of Api Management. ,
StandardV2: StandardV2 SKU of Api Management. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
identity:
{
Description: Managed service identity of the Api Management service. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostic_ListByService (new)
Description :  Lists all diagnostics of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostic_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Diagnostic specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostic_Get (new)
Description :  Gets the details of the Diagnostic specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostic_CreateOrUpdate (new)
Description :  Creates a new Diagnostic or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostic_Update (new)
Description :  Updates the details of the Diagnostic specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Diagnostic Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Diagnostic_Delete (new)
Description :  Deletes the specified Diagnostic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documentation_ListByService (new)
Description :  Lists all Documentations of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documentation_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Documentation by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
documentationId:
{
Description: Documentation identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documentation_Get (new)
Description :  Gets the details of the Documentation specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
documentationId:
{
Description: Documentation identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Markdown documentation details. ,
}
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documentation_CreateOrUpdate (new)
Description :  Creates a new Documentation or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
documentationId:
{
Description: Documentation identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Markdown documentation details. ,
}
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Markdown documentation details. ,
}
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documentation_Update (new)
Description :  Updates the details of the Documentation for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
documentationId:
{
Description: Documentation identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Documentation Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Markdown documentation details. ,
}
{
properties:
{
Description: Markdown Documentation details. ,
Required: False ,
}
{
title:
{
Description: documentation title. ,
Required: False ,
}
string ,
content:
{
Description: Markdown documentation content. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documentation_Delete (new)
Description :  Deletes the specified Documentation from an API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
documentationId:
{
Description: Documentation identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailTemplate_ListByService (new)
Description :  Gets all email templates
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Email Template entity contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: True ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: True ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether the template is the default template provided by API Management or has been edited. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailTemplate_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the email template specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailTemplate_Get (new)
Description :  Gets the details of the email template specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Email Template details. ,
}
{
properties:
{
Description: Email Template entity contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: True ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: True ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether the template is the default template provided by API Management or has been edited. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailTemplate_CreateOrUpdate (new)
Description :  Updates an Email Template.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Email Template update parameters. ,
Required: True ,
}
{
properties:
{
Description: Email Template Update contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: False ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: False ,
}
string ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Email Template entity contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: True ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: True ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether the template is the default template provided by API Management or has been edited. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Email Template entity contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: True ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: True ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether the template is the default template provided by API Management or has been edited. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailTemplate_Update (new)
Description :  Updates API Management email template
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Email Template Update contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: False ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: False ,
}
string ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Email Template details. ,
}
{
properties:
{
Description: Email Template entity contract properties. ,
Required: False ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: True ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: True ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
isDefault:
{
Description: Whether the template is the default template provided by API Management or has been edited. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailTemplate_Delete (new)
Description :  Reset the Email Template to default template provided by the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGatewayConfigConnection_ListByGateway (new)
Description :  List all API Management gateway config connections within a gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management gateway config connection operation. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the API Management gateway config connection. ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of the API Management gateway config connection ,
Required: False ,
}
string ,
sourceId:
{
Description: The link to the API Management service workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
defaultHostname:
{
Description: The default hostname of the data-plane gateway. ,
Required: False ,
}
string ,
hostnames:
{
Description: The hostnames of the data-plane gateway to which requests can be sent. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGatewayConfigConnection_Get (new)
Description :  Gets an API Management gateway config connection resource description.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
configConnectionName:
{
Description: The name of the API Management gateway config connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management gateway config connection. ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of the API Management gateway config connection ,
Required: False ,
}
string ,
sourceId:
{
Description: The link to the API Management service workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
defaultHostname:
{
Description: The default hostname of the data-plane gateway. ,
Required: False ,
}
string ,
hostnames:
{
Description: The hostnames of the data-plane gateway to which requests can be sent. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGatewayConfigConnection_CreateOrUpdate (new)
Description :  Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
configConnectionName:
{
Description: The name of the API Management gateway config connection. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management gateway config connection operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Management gateway config connection. ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of the API Management gateway config connection ,
Required: False ,
}
string ,
sourceId:
{
Description: The link to the API Management service workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
defaultHostname:
{
Description: The default hostname of the data-plane gateway. ,
Required: False ,
}
string ,
hostnames:
{
Description: The hostnames of the data-plane gateway to which requests can be sent. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the API Management gateway config connection. ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of the API Management gateway config connection ,
Required: False ,
}
string ,
sourceId:
{
Description: The link to the API Management service workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
defaultHostname:
{
Description: The default hostname of the data-plane gateway. ,
Required: False ,
}
string ,
hostnames:
{
Description: The hostnames of the data-plane gateway to which requests can be sent. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the API Management gateway config connection. ,
Required: True ,
}
{
provisioningState:
{
Description: The current provisioning state of the API Management gateway config connection ,
Required: False ,
}
string ,
sourceId:
{
Description: The link to the API Management service workspace. ,
Format: arm-id ,
Required: False ,
}
string ,
defaultHostname:
{
Description: The default hostname of the data-plane gateway. ,
Required: False ,
}
string ,
hostnames:
{
Description: The hostnames of the data-plane gateway to which requests can be sent. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiGatewayConfigConnection_Delete (new)
Description :  Deletes an existing API Management gateway config connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the API Management gateway. ,
Required: True ,
}
string ,
configConnectionName:
{
Description: The name of the API Management gateway config connection. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_ListByService (new)
Description :  Lists a collection of gateways registered with service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Gateway specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_Get (new)
Description :  Gets the details of the Gateway specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Gateway details. ,
}
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_CreateOrUpdate (new)
Description :  Creates or updates a Gateway to be used in Api Management instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Gateway details. ,
}
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Gateway details. ,
}
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_Update (new)
Description :  Updates the details of the gateway specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Gateway details. ,
}
{
properties:
{
Description: Gateway details. ,
Required: False ,
}
{
locationData:
{
Description: Gateway location. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gateway description ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_Delete (new)
Description :  Deletes specific Gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_ListKeys (new)
Description :  Retrieves gateway keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Gateway authentication keys. ,
}
{
primary:
{
Description: Primary gateway key. ,
Required: False ,
}
string ,
secondary:
{
Description: Secondary gateway key. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_RegenerateKey (new)
Description :  Regenerates specified gateway key invalidating any tokens created with it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
keyType:
{
Description: The Key being regenerated. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_GenerateToken (new)
Description :  Gets the Shared Access Authorization Token for the gateway.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
keyType:
{
Description: The Key to be used to generate gateway token. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: True ,
}
enum ,
expiry:
{
Description: The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Shared Access Authentication token value for the Gateway. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayHostnameConfiguration_ListByService (new)
Description :  Lists the collection of hostname configurations for the specified gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Gateway hostname configuration details. ,
Required: False ,
}
{
hostname:
{
Description: Hostname value. Supports valid domain name, partial or full wildcard ,
Required: False ,
}
string ,
certificateId:
{
Description: Identifier of Certificate entity that will be used for TLS connection establishment ,
Required: False ,
}
string ,
negotiateClientCertificate:
{
Description: Determines whether gateway requests client certificate ,
Required: False ,
}
boolean ,
tls10Enabled:
{
Description: Specifies if TLS 1.0 is supported ,
Required: False ,
}
boolean ,
tls11Enabled:
{
Description: Specifies if TLS 1.1 is supported ,
Required: False ,
}
boolean ,
http2Enabled:
{
Description: Specifies if HTTP/2.0 is supported ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayHostnameConfiguration_GetEntityTag (new)
Description :  Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
hcId:
{
Description: Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayHostnameConfiguration_Get (new)
Description :  Get details of a hostname configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
hcId:
{
Description: Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Gateway hostname configuration details. ,
}
{
properties:
{
Description: Gateway hostname configuration details. ,
Required: False ,
}
{
hostname:
{
Description: Hostname value. Supports valid domain name, partial or full wildcard ,
Required: False ,
}
string ,
certificateId:
{
Description: Identifier of Certificate entity that will be used for TLS connection establishment ,
Required: False ,
}
string ,
negotiateClientCertificate:
{
Description: Determines whether gateway requests client certificate ,
Required: False ,
}
boolean ,
tls10Enabled:
{
Description: Specifies if TLS 1.0 is supported ,
Required: False ,
}
boolean ,
tls11Enabled:
{
Description: Specifies if TLS 1.1 is supported ,
Required: False ,
}
boolean ,
http2Enabled:
{
Description: Specifies if HTTP/2.0 is supported ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayHostnameConfiguration_CreateOrUpdate (new)
Description :  Creates of updates hostname configuration for a Gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
hcId:
{
Description: Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Gateway hostname configuration details. ,
Required: False ,
}
{
hostname:
{
Description: Hostname value. Supports valid domain name, partial or full wildcard ,
Required: False ,
}
string ,
certificateId:
{
Description: Identifier of Certificate entity that will be used for TLS connection establishment ,
Required: False ,
}
string ,
negotiateClientCertificate:
{
Description: Determines whether gateway requests client certificate ,
Required: False ,
}
boolean ,
tls10Enabled:
{
Description: Specifies if TLS 1.0 is supported ,
Required: False ,
}
boolean ,
tls11Enabled:
{
Description: Specifies if TLS 1.1 is supported ,
Required: False ,
}
boolean ,
http2Enabled:
{
Description: Specifies if HTTP/2.0 is supported ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Gateway hostname configuration details. ,
}
{
properties:
{
Description: Gateway hostname configuration details. ,
Required: False ,
}
{
hostname:
{
Description: Hostname value. Supports valid domain name, partial or full wildcard ,
Required: False ,
}
string ,
certificateId:
{
Description: Identifier of Certificate entity that will be used for TLS connection establishment ,
Required: False ,
}
string ,
negotiateClientCertificate:
{
Description: Determines whether gateway requests client certificate ,
Required: False ,
}
boolean ,
tls10Enabled:
{
Description: Specifies if TLS 1.0 is supported ,
Required: False ,
}
boolean ,
tls11Enabled:
{
Description: Specifies if TLS 1.1 is supported ,
Required: False ,
}
boolean ,
http2Enabled:
{
Description: Specifies if HTTP/2.0 is supported ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Gateway hostname configuration details. ,
}
{
properties:
{
Description: Gateway hostname configuration details. ,
Required: False ,
}
{
hostname:
{
Description: Hostname value. Supports valid domain name, partial or full wildcard ,
Required: False ,
}
string ,
certificateId:
{
Description: Identifier of Certificate entity that will be used for TLS connection establishment ,
Required: False ,
}
string ,
negotiateClientCertificate:
{
Description: Determines whether gateway requests client certificate ,
Required: False ,
}
boolean ,
tls10Enabled:
{
Description: Specifies if TLS 1.0 is supported ,
Required: False ,
}
boolean ,
tls11Enabled:
{
Description: Specifies if TLS 1.1 is supported ,
Required: False ,
}
boolean ,
http2Enabled:
{
Description: Specifies if HTTP/2.0 is supported ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayHostnameConfiguration_Delete (new)
Description :  Deletes the specified hostname configuration from the specified Gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
hcId:
{
Description: Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayApi_ListByService (new)
Description :  Lists a collection of the APIs associated with a gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayApi_GetEntityTag (new)
Description :  Checks that API entity specified by identifier is associated with the Gateway entity.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayApi_CreateOrUpdate (new)
Description :  Adds an API to the specified Gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
parameters:
{
Required: False ,
}
{
properties:
{
Description: Association entity contract properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayApi_Delete (new)
Description :  Deletes the specified API from the specified Gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayCertificateAuthority_ListByService (new)
Description :  Lists the collection of Certificate Authorities for the specified Gateway entity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq, ne | |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Gateway certificate authority details. ,
Required: False ,
}
{
isTrusted:
{
Description: Determines whether certificate authority is trusted. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayCertificateAuthority_GetEntityTag (new)
Description :  Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayCertificateAuthority_Get (new)
Description :  Get assigned Gateway Certificate Authority details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Gateway certificate authority details. ,
}
{
properties:
{
Description: Gateway certificate authority details. ,
Required: False ,
}
{
isTrusted:
{
Description: Determines whether certificate authority is trusted. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayCertificateAuthority_CreateOrUpdate (new)
Description :  Assign Certificate entity to Gateway entity as Certificate Authority.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Gateway certificate authority details. ,
Required: False ,
}
{
isTrusted:
{
Description: Determines whether certificate authority is trusted. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Gateway certificate authority details. ,
}
{
properties:
{
Description: Gateway certificate authority details. ,
Required: False ,
}
{
isTrusted:
{
Description: Determines whether certificate authority is trusted. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Gateway certificate authority details. ,
}
{
properties:
{
Description: Gateway certificate authority details. ,
Required: False ,
}
{
isTrusted:
{
Description: Determines whether certificate authority is trusted. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GatewayCertificateAuthority_Delete (new)
Description :  Remove relationship between Certificate Authority and Gateway entity.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_InvalidateDebugCredentials (new)
Description :  Action is invalidating all debug credentials issued for gateway.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/invalidateDebugCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_ListDebugCredentials (new)
Description :  Create new debug credentials for gateway.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listDebugCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: List debug credentials properties. ,
Required: True ,
}
{
credentialsExpireAfter:
{
Description: Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used. ,
Format: duration ,
Required: False ,
}
string ,
purposes:
{
Description: Purposes of debug credential. ,
Required: True ,
}
[
string ,
]
,
apiId:
{
Description: Full resource Id of an API. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
token:
{
Description: Gateway debug token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateway_ListTrace (new)
Description :  Fetches trace collected by gateway.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listTrace
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
gatewayId:
{
Description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: List trace properties. ,
Required: True ,
}
{
traceId:
{
Description: Trace id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Trace collected in gateway. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Group_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Group_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Group_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. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Group_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Properties supplied to Create Group operation. ,
Required: False ,
}
{
displayName:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. ,
Required: False ,
}
string ,
type:
{
Description: Group type. ,
Enum:
{
custom: No description available. ,
system: No description available. ,
external: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Group_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Group entity update contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Group name. ,
Required: False ,
}
string ,
description:
{
Description: Group description. ,
Required: False ,
}
string ,
type:
{
Description: Group type. ,
Enum:
{
custom: No description available. ,
system: No description available. ,
external: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Group_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. The name is case insensitive. ,
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 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupUser_List (new)
Description :  Lists a collection of user entities associated with the group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupUser_CheckEntityExists (new)
Description :  Checks that user entity specified by identifier is associated with the group entity.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupUser_Create (new)
Description :  Add existing user to existing group
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupUser_Delete (new)
Description :  Remove existing user from existing group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_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
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Identity Provider configuration values. ,
Required: False ,
}
[
{
properties:
{
Description: Identity Provider contract properties. ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the identityProvider specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_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}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Identity Provider details. ,
}
{
properties:
{
Description: Identity Provider contract properties. ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Identity Provider contract properties. ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: True ,
}
string ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Identity Provider details. ,
}
{
properties:
{
Description: Identity Provider contract properties. ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Identity Provider details. ,
}
{
properties:
{
Description: Identity Provider contract properties. ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Identity Provider update properties. ,
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: 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 ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Identity Provider details. ,
}
{
properties:
{
Description: Identity Provider contract properties. ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
certificateId:
{
Description: Certificate full resource ID used in external Identity Provider ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_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. The name is case insensitive. ,
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: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IdentityProvider_ListSecrets (new)
Description :  Gets the client secret details of the Identity Provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. ,
}
{
clientSecret:
{
Description: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_ListByService (new)
Description :  Lists a collection of issues in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Issue values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Issue_Get (new)
Description :  Gets API Management issue details
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
issueId:
{
Description: Issue identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Issue Contract details. ,
}
{
properties:
{
Description: Properties of the Issue. ,
Required: False ,
}
{
title:
{
Description: The issue title. ,
Required: True ,
}
string ,
description:
{
Description: Text describing the issue. ,
Required: True ,
}
string ,
userId:
{
Description: A resource identifier for the user created the issue. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Logger_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Logger values. ,
Required: False ,
}
[
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Logger_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the logger specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Logger_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Logger_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Logger_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Logger entity update contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: Logger credentials. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Logger_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_ListByService (new)
Description :  Lists a collection of named values defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | 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 ,
isKeyVaultRefreshFailed:
{
Description: When set to true, the response contains only named value entities which failed refresh. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_Get (new)
Description :  Gets the details of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_CreateOrUpdate (new)
Description :  Creates or updates named value.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: NamedValue entity contract properties for PUT operation. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
secretIdentifier:
{
Description: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi ,
Required: False ,
}
string ,
identityClientId:
{
Description: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_Update (new)
Description :  Updates the specific named value.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: NamedValue entity Update contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: False ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
secretIdentifier:
{
Description: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi ,
Required: False ,
}
string ,
identityClientId:
{
Description: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
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: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_Delete (new)
Description :  Deletes specific named value from the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_ListValue (new)
Description :  Gets the secret of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/listValue
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. ,
}
{
value:
{
Description: This is secret value of the NamedValue entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamedValue_RefreshSecret (new)
Description :  Refresh the secret of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/refreshSecret
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
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: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkStatus_ListByService (new)
Description :  Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Location of service ,
Required: False ,
}
string ,
networkStatus:
{
Description: Network status in Location ,
Required: False ,
}
{
dnsServers:
{
Description: Gets the list of DNS servers IPV4 addresses. ,
Required: True ,
}
[
string ,
]
,
connectivityStatus:
{
Description: Gets the list of Connectivity Status to the Resources on which the service depends upon. ,
Required: True ,
}
[
{
name:
{
Description: The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon. ,
Required: True ,
}
string ,
status:
{
Description: Resource Connectivity Status Type identifier. ,
Enum:
{
initializing: No description available. ,
success: No description available. ,
failure: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error details of the connectivity to the resource. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.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 ,
lastStatusChange:
{
Description: The date when the resource connectivity status last Changed from success to failure or vice-versa. 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 ,
resourceType:
{
Description: Resource Type. ,
Required: True ,
}
string ,
isOptional:
{
Description: Whether this is optional. ,
Required: True ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkStatus_ListByLocation (new)
Description :  Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
locationName:
{
Description: Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
dnsServers:
{
Description: Gets the list of DNS servers IPV4 addresses. ,
Required: True ,
}
[
string ,
]
,
connectivityStatus:
{
Description: Gets the list of Connectivity Status to the Resources on which the service depends upon. ,
Required: True ,
}
[
{
name:
{
Description: The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon. ,
Required: True ,
}
string ,
status:
{
Description: Resource Connectivity Status Type identifier. ,
Enum:
{
initializing: No description available. ,
success: No description available. ,
failure: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error details of the connectivity to the resource. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.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 ,
lastStatusChange:
{
Description: The date when the resource connectivity status last Changed from success to failure or vice-versa. 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 ,
resourceType:
{
Description: Resource Type. ,
Required: True ,
}
string ,
isOptional:
{
Description: Whether this is optional. ,
Required: True ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Notification_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}/notifications
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Notification entity contract properties. ,
Required: False ,
}
{
title:
{
Description: Title of the Notification. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Notification. ,
Required: False ,
}
string ,
recipients:
{
Description: Recipient Parameter values. ,
Required: False ,
}
{
emails:
{
Description: List of Emails subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
users:
{
Description: List of Users subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Notification_Get (new)
Description :  Gets the details of the Notification specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Notification entity contract properties. ,
Required: False ,
}
{
title:
{
Description: Title of the Notification. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Notification. ,
Required: False ,
}
string ,
recipients:
{
Description: Recipient Parameter values. ,
Required: False ,
}
{
emails:
{
Description: List of Emails subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
users:
{
Description: List of Users subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Notification_CreateOrUpdate (new)
Description :  Create or Update API Management publisher notification.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Notification entity contract properties. ,
Required: False ,
}
{
title:
{
Description: Title of the Notification. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Notification. ,
Required: False ,
}
string ,
recipients:
{
Description: Recipient Parameter values. ,
Required: False ,
}
{
emails:
{
Description: List of Emails subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
users:
{
Description: List of Users subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientUser_ListByNotification (new)
Description :  Gets the list of the Notification Recipient User subscribed to the notification.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Recipient User entity contract properties. ,
Required: False ,
}
{
userId:
{
Description: API Management UserId subscribed to notification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientUser_CheckEntityExists (new)
Description :  Determine if the Notification Recipient User is subscribed to the notification.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientUser_CreateOrUpdate (new)
Description :  Adds the API Management User to the list of Recipients for the Notification.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Recipient User entity contract properties. ,
Required: False ,
}
{
userId:
{
Description: API Management UserId subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Recipient User entity contract properties. ,
Required: False ,
}
{
userId:
{
Description: API Management UserId subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientUser_Delete (new)
Description :  Removes the API Management user from the list of Notification.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientEmail_ListByNotification (new)
Description :  Gets the list of the Notification Recipient Emails subscribed to a notification.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Recipient Email contract properties. ,
Required: False ,
}
{
email:
{
Description: User Email subscribed to notification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientEmail_CheckEntityExists (new)
Description :  Determine if Notification Recipient Email subscribed to the notification.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
email:
{
Description: Email identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientEmail_CreateOrUpdate (new)
Description :  Adds the Email address to the list of Recipients for the Notification.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
email:
{
Description: Email identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Recipient Email contract properties. ,
Required: False ,
}
{
email:
{
Description: User Email subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Recipient Email contract properties. ,
Required: False ,
}
{
email:
{
Description: User Email subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRecipientEmail_Delete (new)
Description :  Removes the email from the list of Notification.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
email:
{
Description: Email identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_ListByService (new)
Description :  Lists of all the 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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: OpenId Connect Provider contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_Get (new)
Description :  Gets specific OpenID Connect Provider without secrets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: OpenId Connect Provider details. ,
}
{
properties:
{
Description: OpenId Connect Provider contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: OpenId Connect Provider contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: OpenId Connect Provider details. ,
}
{
properties:
{
Description: OpenId Connect Provider contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: OpenId Connect Provider details. ,
}
{
properties:
{
Description: OpenId Connect Provider contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: OpenId Connect Provider Update contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: OpenId Connect Provider details. ,
}
{
properties:
{
Description: OpenId Connect Provider contract properties. ,
Required: False ,
}
{
displayName:
{
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 ,
useInTestConsole:
{
Description: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. ,
Required: False ,
}
boolean ,
useInApiDocumentation:
{
Description: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_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. The name is case insensitive. ,
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: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OpenIdConnectProvider_ListSecrets (new)
Description :  Gets the client secret details of the OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. ,
}
{
clientSecret:
{
Description: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OutboundNetworkDependenciesEndpoints_ListByService (new)
Description :  Gets the network endpoints of all outbound dependencies of a ApiManagement service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
category:
{
Description: The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that the Api Management Service reaches the service at. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The Ports used when connecting to DomainName. ,
Required: False ,
}
[
{
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
region:
{
Description: The region of the dependency. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_ListByService (new)
Description :  Lists all the Global Policy definitions of the Api Management service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Global policy definition in the Api Management service.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Get (new)
Description :  Get the Global policy definition of the Api Management service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_CreateOrUpdate (new)
Description :  Creates or updates the global policy configuration of the Api Management service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policy_Delete (new)
Description :  Deletes the global policy configuration of the Api Management Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDescription_ListByService (new)
Description :  Lists all policy descriptions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Descriptions of API Management policies. ,
Required: False ,
}
[
{
properties:
{
Description: Policy description contract properties. ,
Required: False ,
}
{
description:
{
Description: Policy description. ,
Required: False ,
}
string ,
scope:
{
Description: Binary OR value of the Snippet scope. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyFragment_ListByService (new)
Description :  Gets all policy fragments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
 ,
Required: False ,
}
string ,
$orderby:
{
Description: OData order by query option. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: Policy fragment contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyFragment_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of a policy fragment.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyFragment_Get (new)
Description :  Gets a policy fragment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
format:
{
Description: Policy fragment content format. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy fragment contract details. ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyFragment_CreateOrUpdate (new)
Description :  Creates or updates a policy fragment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy fragment contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Policy fragment contract details. ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Policy fragment contract details. ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyFragment_Delete (new)
Description :  Deletes a policy fragment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyFragment_ListReferences (new)
Description :  Lists policy resources that reference the policy fragment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}/listReferences
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of resources. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestriction_ListByService (new)
Description :  Gets all policy restrictions of API Management services.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestriction_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the policy restriction in the Api Management service.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyRestrictionId:
{
Description: Policy restrictions after an entity level ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestriction_Get (new)
Description :  Get the policy restriction of the Api Management service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyRestrictionId:
{
Description: Policy restrictions after an entity level ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy restriction contract details. ,
}
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestriction_CreateOrUpdate (new)
Description :  Creates or updates the policy restriction configuration of the Api Management service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyRestrictionId:
{
Description: Policy restrictions after an entity level ,
Required: True ,
}
string ,
parameters:
{
Description: The policy restriction to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy restriction contract details. ,
}
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version ,
}
string ,
}
,
$schema:
{
Description: Policy restriction contract details. ,
}
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestriction_Update (new)
Description :  Updates the policy restriction configuration of the Api Management service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyRestrictionId:
{
Description: Policy restrictions after an entity level ,
Required: True ,
}
string ,
parameters:
{
Description: The policy restriction to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version ,
}
string ,
}
,
$schema:
{
Description: Policy restriction contract details. ,
}
{
properties:
{
Description: Properties of the Policy Restriction. ,
Required: False ,
}
{
scope:
{
Description: Path to the policy document. ,
Required: False ,
}
string ,
requireBase:
{
Description: Indicates if base policy should be enforced for the policy document. ,
Enum:
{
true: The policy is required to have base policy ,
false: The policy does not require to have base policy ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestriction_Delete (new)
Description :  Deletes the policy restriction configuration of the Api Management Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
policyRestrictionId:
{
Description: Policy restrictions after an entity level ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyRestrictionValidations_ByService (new)
Description :  Validate all policies of API Management services.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/validatePolicies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: location of the header. ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalConfig_ListByService (new)
Description :  Lists the developer portal configurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The developer portal configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The developer portal configuration contract properties. ,
Required: False ,
}
{
enableBasicAuth:
{
Description: Enable or disable Basic authentication method. ,
Required: False ,
}
boolean ,
signin:
{
Required: False ,
}
{
require:
{
Description: Redirect anonymous users to the sign-in page. ,
Required: False ,
}
boolean ,
}
,
signup:
{
Required: False ,
}
{
termsOfService:
{
Description: Terms of service settings. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
requireConsent:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
delegation:
{
Description: The developer portal delegation settings. ,
Required: False ,
}
{
delegateRegistration:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
delegateSubscription:
{
Description: Enable or disable delegation for product subscriptions. ,
Required: False ,
}
boolean ,
delegationUrl:
{
Description: A delegation endpoint URL. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to ensure requests originate from Azure API Management service. ,
Required: False ,
}
string ,
}
,
cors:
{
Description: The developer portal Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Allowed origins, e.g. `https://trusted.com`. ,
Required: False ,
}
[
string ,
]
,
}
,
csp:
{
Description: The developer portal Content Security Policy (CSP) settings. ,
Required: False ,
}
{
mode:
{
Description: The mode of the developer portal Content Security Policy (CSP). ,
Enum:
{
enabled: The browser will block requests not matching allowed origins. ,
disabled: The browser will not apply the origin restrictions. ,
reportOnly: The browser will report requests not matching allowed origins without blocking them. ,
}
,
Required: False ,
}
enum ,
reportUri:
{
Description: The URLs used by the browser to report CSP violations. ,
Required: False ,
}
[
string ,
]
,
allowedSources:
{
Description: Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalConfig_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the developer portal configuration.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalConfigId:
{
Description: Portal configuration identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalConfig_Get (new)
Description :  Get the developer portal configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalConfigId:
{
Description: Portal configuration identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 developer portal configuration contract. ,
}
{
properties:
{
Description: The developer portal configuration contract properties. ,
Required: False ,
}
{
enableBasicAuth:
{
Description: Enable or disable Basic authentication method. ,
Required: False ,
}
boolean ,
signin:
{
Required: False ,
}
{
require:
{
Description: Redirect anonymous users to the sign-in page. ,
Required: False ,
}
boolean ,
}
,
signup:
{
Required: False ,
}
{
termsOfService:
{
Description: Terms of service settings. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
requireConsent:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
delegation:
{
Description: The developer portal delegation settings. ,
Required: False ,
}
{
delegateRegistration:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
delegateSubscription:
{
Description: Enable or disable delegation for product subscriptions. ,
Required: False ,
}
boolean ,
delegationUrl:
{
Description: A delegation endpoint URL. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to ensure requests originate from Azure API Management service. ,
Required: False ,
}
string ,
}
,
cors:
{
Description: The developer portal Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Allowed origins, e.g. `https://trusted.com`. ,
Required: False ,
}
[
string ,
]
,
}
,
csp:
{
Description: The developer portal Content Security Policy (CSP) settings. ,
Required: False ,
}
{
mode:
{
Description: The mode of the developer portal Content Security Policy (CSP). ,
Enum:
{
enabled: The browser will block requests not matching allowed origins. ,
disabled: The browser will not apply the origin restrictions. ,
reportOnly: The browser will report requests not matching allowed origins without blocking them. ,
}
,
Required: False ,
}
enum ,
reportUri:
{
Description: The URLs used by the browser to report CSP violations. ,
Required: False ,
}
[
string ,
]
,
allowedSources:
{
Description: Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalConfig_Update (new)
Description :  Update the developer portal configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalConfigId:
{
Description: Portal configuration identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Update the developer portal configuration. ,
Required: True ,
}
{
properties:
{
Description: The developer portal configuration contract properties. ,
Required: False ,
}
{
enableBasicAuth:
{
Description: Enable or disable Basic authentication method. ,
Required: False ,
}
boolean ,
signin:
{
Required: False ,
}
{
require:
{
Description: Redirect anonymous users to the sign-in page. ,
Required: False ,
}
boolean ,
}
,
signup:
{
Required: False ,
}
{
termsOfService:
{
Description: Terms of service settings. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
requireConsent:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
delegation:
{
Description: The developer portal delegation settings. ,
Required: False ,
}
{
delegateRegistration:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
delegateSubscription:
{
Description: Enable or disable delegation for product subscriptions. ,
Required: False ,
}
boolean ,
delegationUrl:
{
Description: A delegation endpoint URL. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to ensure requests originate from Azure API Management service. ,
Required: False ,
}
string ,
}
,
cors:
{
Description: The developer portal Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Allowed origins, e.g. `https://trusted.com`. ,
Required: False ,
}
[
string ,
]
,
}
,
csp:
{
Description: The developer portal Content Security Policy (CSP) settings. ,
Required: False ,
}
{
mode:
{
Description: The mode of the developer portal Content Security Policy (CSP). ,
Enum:
{
enabled: The browser will block requests not matching allowed origins. ,
disabled: The browser will not apply the origin restrictions. ,
reportOnly: The browser will report requests not matching allowed origins without blocking them. ,
}
,
Required: False ,
}
enum ,
reportUri:
{
Description: The URLs used by the browser to report CSP violations. ,
Required: False ,
}
[
string ,
]
,
allowedSources:
{
Description: Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The developer portal configuration contract properties. ,
Required: False ,
}
{
enableBasicAuth:
{
Description: Enable or disable Basic authentication method. ,
Required: False ,
}
boolean ,
signin:
{
Required: False ,
}
{
require:
{
Description: Redirect anonymous users to the sign-in page. ,
Required: False ,
}
boolean ,
}
,
signup:
{
Required: False ,
}
{
termsOfService:
{
Description: Terms of service settings. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
requireConsent:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
delegation:
{
Description: The developer portal delegation settings. ,
Required: False ,
}
{
delegateRegistration:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
delegateSubscription:
{
Description: Enable or disable delegation for product subscriptions. ,
Required: False ,
}
boolean ,
delegationUrl:
{
Description: A delegation endpoint URL. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to ensure requests originate from Azure API Management service. ,
Required: False ,
}
string ,
}
,
cors:
{
Description: The developer portal Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Allowed origins, e.g. `https://trusted.com`. ,
Required: False ,
}
[
string ,
]
,
}
,
csp:
{
Description: The developer portal Content Security Policy (CSP) settings. ,
Required: False ,
}
{
mode:
{
Description: The mode of the developer portal Content Security Policy (CSP). ,
Enum:
{
enabled: The browser will block requests not matching allowed origins. ,
disabled: The browser will not apply the origin restrictions. ,
reportOnly: The browser will report requests not matching allowed origins without blocking them. ,
}
,
Required: False ,
}
enum ,
reportUri:
{
Description: The URLs used by the browser to report CSP violations. ,
Required: False ,
}
[
string ,
]
,
allowedSources:
{
Description: Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalConfig_CreateOrUpdate (new)
Description :  Create or update the developer portal configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalConfigId:
{
Description: Portal configuration identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Update the developer portal configuration. ,
Required: True ,
}
{
properties:
{
Description: The developer portal configuration contract properties. ,
Required: False ,
}
{
enableBasicAuth:
{
Description: Enable or disable Basic authentication method. ,
Required: False ,
}
boolean ,
signin:
{
Required: False ,
}
{
require:
{
Description: Redirect anonymous users to the sign-in page. ,
Required: False ,
}
boolean ,
}
,
signup:
{
Required: False ,
}
{
termsOfService:
{
Description: Terms of service settings. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
requireConsent:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
delegation:
{
Description: The developer portal delegation settings. ,
Required: False ,
}
{
delegateRegistration:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
delegateSubscription:
{
Description: Enable or disable delegation for product subscriptions. ,
Required: False ,
}
boolean ,
delegationUrl:
{
Description: A delegation endpoint URL. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to ensure requests originate from Azure API Management service. ,
Required: False ,
}
string ,
}
,
cors:
{
Description: The developer portal Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Allowed origins, e.g. `https://trusted.com`. ,
Required: False ,
}
[
string ,
]
,
}
,
csp:
{
Description: The developer portal Content Security Policy (CSP) settings. ,
Required: False ,
}
{
mode:
{
Description: The mode of the developer portal Content Security Policy (CSP). ,
Enum:
{
enabled: The browser will block requests not matching allowed origins. ,
disabled: The browser will not apply the origin restrictions. ,
reportOnly: The browser will report requests not matching allowed origins without blocking them. ,
}
,
Required: False ,
}
enum ,
reportUri:
{
Description: The URLs used by the browser to report CSP violations. ,
Required: False ,
}
[
string ,
]
,
allowedSources:
{
Description: Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The developer portal configuration contract properties. ,
Required: False ,
}
{
enableBasicAuth:
{
Description: Enable or disable Basic authentication method. ,
Required: False ,
}
boolean ,
signin:
{
Required: False ,
}
{
require:
{
Description: Redirect anonymous users to the sign-in page. ,
Required: False ,
}
boolean ,
}
,
signup:
{
Required: False ,
}
{
termsOfService:
{
Description: Terms of service settings. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
requireConsent:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
delegation:
{
Description: The developer portal delegation settings. ,
Required: False ,
}
{
delegateRegistration:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
delegateSubscription:
{
Description: Enable or disable delegation for product subscriptions. ,
Required: False ,
}
boolean ,
delegationUrl:
{
Description: A delegation endpoint URL. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to ensure requests originate from Azure API Management service. ,
Required: False ,
}
string ,
}
,
cors:
{
Description: The developer portal Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Allowed origins, e.g. `https://trusted.com`. ,
Required: False ,
}
[
string ,
]
,
}
,
csp:
{
Description: The developer portal Content Security Policy (CSP) settings. ,
Required: False ,
}
{
mode:
{
Description: The mode of the developer portal Content Security Policy (CSP). ,
Enum:
{
enabled: The browser will block requests not matching allowed origins. ,
disabled: The browser will not apply the origin restrictions. ,
reportOnly: The browser will report requests not matching allowed origins without blocking them. ,
}
,
Required: False ,
}
enum ,
reportUri:
{
Description: The URLs used by the browser to report CSP violations. ,
Required: False ,
}
[
string ,
]
,
allowedSources:
{
Description: Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalRevision_ListByService (new)
Description :  Lists developer portal's revisions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq, ne | | ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of portal revisions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the portal revisions. ,
Required: False ,
}
{
description:
{
Description: Portal revision description. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Portal revision publishing status details. ,
Required: False ,
}
string ,
status:
{
Description: Status of the portal's revision. ,
Enum:
{
pending: Portal's revision has been queued. ,
publishing: Portal's revision is being published. ,
completed: Portal's revision publishing completed. ,
failed: Portal's revision publishing failed. ,
}
,
Required: False ,
}
enum ,
isCurrent:
{
Description: Indicates if the portal's revision is public. ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: Portal's revision creation date and time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDateTime:
{
Description: Last updated date and time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalRevision_GetEntityTag (new)
Description :  Gets the developer portal revision specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalRevisionId:
{
Description: Portal revision identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalRevision_Get (new)
Description :  Gets the developer portal's revision specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalRevisionId:
{
Description: Portal revision identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Portal Revision's contract details. ,
}
{
properties:
{
Description: Properties of the portal revisions. ,
Required: False ,
}
{
description:
{
Description: Portal revision description. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Portal revision publishing status details. ,
Required: False ,
}
string ,
status:
{
Description: Status of the portal's revision. ,
Enum:
{
pending: Portal's revision has been queued. ,
publishing: Portal's revision is being published. ,
completed: Portal's revision publishing completed. ,
failed: Portal's revision publishing failed. ,
}
,
Required: False ,
}
enum ,
isCurrent:
{
Description: Indicates if the portal's revision is public. ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: Portal's revision creation date and time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDateTime:
{
Description: Last updated date and time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalRevision_CreateOrUpdate (new)
Description :  Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalRevisionId:
{
Description: Portal revision identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of the portal revisions. ,
Required: False ,
}
{
description:
{
Description: Portal revision description. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Portal revision publishing status details. ,
Required: False ,
}
string ,
status:
{
Description: Status of the portal's revision. ,
Enum:
{
pending: Portal's revision has been queued. ,
publishing: Portal's revision is being published. ,
completed: Portal's revision publishing completed. ,
failed: Portal's revision publishing failed. ,
}
,
Required: False ,
}
enum ,
isCurrent:
{
Description: Indicates if the portal's revision is public. ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: Portal's revision creation date and time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDateTime:
{
Description: Last updated date and time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Portal Revision's contract details. ,
}
{
properties:
{
Description: Properties of the portal revisions. ,
Required: False ,
}
{
description:
{
Description: Portal revision description. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Portal revision publishing status details. ,
Required: False ,
}
string ,
status:
{
Description: Status of the portal's revision. ,
Enum:
{
pending: Portal's revision has been queued. ,
publishing: Portal's revision is being published. ,
completed: Portal's revision publishing completed. ,
failed: Portal's revision publishing failed. ,
}
,
Required: False ,
}
enum ,
isCurrent:
{
Description: Indicates if the portal's revision is public. ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: Portal's revision creation date and time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDateTime:
{
Description: Last updated date and time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalRevision_Update (new)
Description :  Updates the description of specified portal revision or makes it current.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
portalRevisionId:
{
Description: Portal revision identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of the portal revisions. ,
Required: False ,
}
{
description:
{
Description: Portal revision description. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Portal revision publishing status details. ,
Required: False ,
}
string ,
status:
{
Description: Status of the portal's revision. ,
Enum:
{
pending: Portal's revision has been queued. ,
publishing: Portal's revision is being published. ,
completed: Portal's revision publishing completed. ,
failed: Portal's revision publishing failed. ,
}
,
Required: False ,
}
enum ,
isCurrent:
{
Description: Indicates if the portal's revision is public. ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: Portal's revision creation date and time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDateTime:
{
Description: Last updated date and time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
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: Portal Revision's contract details. ,
}
{
properties:
{
Description: Properties of the portal revisions. ,
Required: False ,
}
{
description:
{
Description: Portal revision description. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Portal revision publishing status details. ,
Required: False ,
}
string ,
status:
{
Description: Status of the portal's revision. ,
Enum:
{
pending: Portal's revision has been queued. ,
publishing: Portal's revision is being published. ,
completed: Portal's revision publishing completed. ,
failed: Portal's revision publishing failed. ,
}
,
Required: False ,
}
enum ,
isCurrent:
{
Description: Indicates if the portal's revision is public. ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: Portal's revision creation date and time. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDateTime:
{
Description: Last updated date and time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PortalSettings_ListByService (new)
Description :  Lists a collection of portalsettings defined within a service instance..
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Descriptions of API Management policies. ,
Required: False ,
}
[
{
properties:
{
Description: Portal Settings contract properties. ,
Required: False ,
}
{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignInSettings_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the SignInSettings.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignInSettings_Get (new)
Description :  Get Sign In Settings for the Portal
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Sign-In settings for the Developer Portal. ,
}
{
properties:
{
Description: Sign-in settings contract properties. ,
Required: False ,
}
{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignInSettings_Update (new)
Description :  Update Sign-In settings.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Update Sign-In settings. ,
Required: True ,
}
{
properties:
{
Description: Sign-in settings contract properties. ,
Required: False ,
}
{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignInSettings_CreateOrUpdate (new)
Description :  Create or Update Sign-In settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Sign-in settings contract properties. ,
Required: False ,
}
{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignUpSettings_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the SignUpSettings.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignUpSettings_Get (new)
Description :  Get Sign Up Settings for the Portal
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignUpSettings_Update (new)
Description :  Update Sign-Up settings.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Update Sign-Up settings. ,
Required: True ,
}
{
properties:
{
Description: Sign-up settings contract properties. ,
Required: False ,
}
{
enabled:
{
Description: Allow users to sign up on a developer portal. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignUpSettings_CreateOrUpdate (new)
Description :  Create or Update Sign-Up settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Sign-up settings contract properties. ,
Required: False ,
}
{
enabled:
{
Description: Allow users to sign up on a developer portal. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegationSettings_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the DelegationSettings.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegationSettings_Get (new)
Description :  Get Delegation Settings for the Portal.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegationSettings_Update (new)
Description :  Update Delegation settings.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Update Delegation settings. ,
Required: True ,
}
{
properties:
{
Description: Delegation settings contract properties. ,
Required: False ,
}
{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegationSettings_CreateOrUpdate (new)
Description :  Create or Update Delegation settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Delegation settings contract properties. ,
Required: False ,
}
{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegationSettings_ListSecrets (new)
Description :  Gets the secret validation key of the DelegationSettings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
validationKey:
{
Description: This is secret value of the validation key in portal settings. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_ListByService (new)
Description :  Lists all private endpoint connections of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_GetByName (new)
Description :  Gets the details of the Private Endpoint Connection specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_CreateOrUpdate (new)
Description :  Creates a new Private Endpoint Connection or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
privateEndpointConnectionRequest:
{
Required: True ,
}
{
id:
{
Description: Private Endpoint Connection Resource Id. ,
Required: False ,
}
string ,
properties:
{
Description: The connection state of the private endpoint connection. ,
Required: False ,
}
{
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Delete (new)
Description :  Deletes the specified Private Endpoint Connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_ListPrivateLinkResources (new)
Description :  Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_GetPrivateLinkResource (new)
Description :  Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
privateLinkSubResourceName:
{
Description: Name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
 ,
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 ,
tags:
{
Description: Products which are part of a specific tag. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the product specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_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. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_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. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_Update (new)
Description :  Update existing product details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
{
properties:
{
Description: Product entity Update contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_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. The name is case insensitive. ,
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 ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
deleteSubscriptions:
{
Description: Delete existing subscriptions associated with the product or not. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductApi_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. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductApi_CheckEntityExists (new)
Description :  Checks that API entity specified by identifier is associated with the Product entity.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductApi_CreateOrUpdate (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. The name is case insensitive. ,
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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductApi_Delete (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. The name is case insensitive. ,
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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductGroup_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. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductGroup_CheckEntityExists (new)
Description :  Checks that Group entity specified by identifier is associated with the Product entity.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductGroup_CreateOrUpdate (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. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductGroup_Delete (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. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductSubscriptions_List (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. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductPolicy_ListByProduct (new)
Description :  Get the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductPolicy_GetEntityTag (new)
Description :  Get the ETag of the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductPolicy_Get (new)
Description :  Get the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the Product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductPolicy_Delete (new)
Description :  Deletes the policy configuration at the Product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_ListByProduct (new)
Description :  Lists all Tags associated with the Product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetEntityStateByProduct (new)
Description :  Gets the entity state version of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetByProduct (new)
Description :  Get tag associated with the Product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_AssignToProduct (new)
Description :  Assign tag to the Product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_DetachFromProduct (new)
Description :  Detach the tag from the Product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductWiki_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductWiki_Get (new)
Description :  Gets the details of the Wiki for a Product specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductWiki_CreateOrUpdate (new)
Description :  Creates a new Wiki for a Product or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 parameters. ,
Required: True ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductWiki_Update (new)
Description :  Updates the details of the Wiki for a Product specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: Wiki Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Wiki properties ,
}
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductWiki_Delete (new)
Description :  Deletes the specified Wiki from a Product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProductWikis_list (new)
Description :  Gets the details of the Wiki for a Product specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
 ,
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 ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Paged Wiki list representation. ,
}
{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Wiki details. ,
Required: False ,
}
{
documents:
{
Description: Collection wiki documents included into this wiki. ,
Required: False ,
}
[
{
documentationId:
{
Description: Documentation Identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Product_ListByTags (new)
Description :  Lists a collection of products associated with tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | 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 ,
includeNotTaggedProducts:
{
Description: Include not tagged Products. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
tag:
{
Description: Tag associated with the resource. ,
Required: True ,
}
{
id:
{
Description: Tag identifier ,
Required: False ,
}
string ,
name:
{
Description: Tag Name ,
Required: False ,
}
string ,
}
,
api:
{
Description: API associated with the tag. ,
Required: False ,
}
{
id:
{
Description: API identifier in the form /apis/{apiId}. ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
operation:
{
Description: Operation associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the operation in form /operations/{operationId}. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
apiName:
{
Description: API Name. ,
Required: False ,
}
string ,
apiRevision:
{
Description: API Revision. ,
Required: False ,
}
string ,
apiVersion:
{
Description: API Version. ,
Required: False ,
}
string ,
description:
{
Description: Operation Description. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
product:
{
Description: Product associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the product in the form of /products/{productId} ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
parameters:
{
Description: The value of the quota counter to be applied to all quota counter periods. ,
Required: True ,
}
{
properties:
{
Description: Quota counter value details. ,
Required: False ,
}
{
callsCount:
{
Description: Number of times Counter was called. ,
Format: int32 ,
Required: False ,
}
integer ,
kbTransferred:
{
Description: Data Transferred in KiloBytes. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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}/periods/{quotaPeriodKey}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
quotaPeriodKey:
{
Description: Quota period key identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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}/periods/{quotaPeriodKey}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
quotaPeriodKey:
{
Description: Quota period key identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The value of the Quota counter to be applied on the specified period. ,
Required: True ,
}
{
properties:
{
Description: Quota counter value details. ,
Required: False ,
}
{
callsCount:
{
Description: Number of times Counter was called. ,
Format: int32 ,
Required: False ,
}
integer ,
kbTransferred:
{
Description: Data Transferred in KiloBytes. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Region_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Lists of Regions. ,
Required: False ,
}
[
{
name:
{
Description: Region name. ,
Required: False ,
}
string ,
isMasterRegion:
{
Description: whether Region is the master region. ,
Required: False ,
}
boolean ,
isDeleted:
{
Description: whether Region is deleted. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByApi (new)
Description :  Lists report records by API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: OData order by query option. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByUser (new)
Description :  Lists report records by User.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | select, filter | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: OData order by query option. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByOperation (new)
Description :  Lists report records by API Operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: OData order by query option. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByProduct (new)
Description :  Lists report records by Product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: OData order by query option. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByGeo (new)
Description :  Lists report records by geography.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| country | select | | |
| region | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListBySubscription (new)
Description :  Lists report records by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: OData order by query option. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByTime (new)
Description :  Lists report records by Time.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter, select | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: OData order by query option. ,
Required: False ,
}
string ,
interval:
{
Description: By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)). ,
Format: duration ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reports_ListByRequest (new)
Description :  Lists report records by Request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |
,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchema_ListByService (new)
Description :  Lists a collection of schemas registered with service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Global Schema Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchema_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Schema specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchema_Get (new)
Description :  Gets the details of the Schema specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Global Schema Contract details. ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchema_CreateOrUpdate (new)
Description :  Creates new or updates existing specified Schema of the API Management service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Global Schema Contract details. ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Global Schema Contract details. ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchema_Delete (new)
Description :  Deletes specific Schema.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantSettings_ListByService (new)
Description :  Public settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: Not used ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: TenantSettings entity contract properties. ,
Required: False ,
}
{
settings:
{
Description: Tenant settings ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantSettings_Get (new)
Description :  Get tenant settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
settingsType:
{
Description: The identifier of the settings. ,
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 Settings. ,
}
{
properties:
{
Description: TenantSettings entity contract properties. ,
Required: False ,
}
{
settings:
{
Description: Tenant settings ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApiManagementSkus_List (new)
Description :  Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the subscription. ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
name:
{
Description: The name of SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
size:
{
Description: The Size of the SKU. ,
Required: False ,
}
string ,
family:
{
Description: The Family of this particular SKU. ,
Required: False ,
}
string ,
kind:
{
Description: The Kind of resources that are supported in this SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity that can be set. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
locations:
{
Description: The set of locations that the SKU is available. ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: A list of locations and availability zones in those locations where the SKU is available. ,
Required: False ,
}
[
{
location:
{
Description: Location of the SKU ,
Required: False ,
}
string ,
zones:
{
Description: List of availability zones where the SKU is supported. ,
Required: False ,
}
[
string ,
]
,
zoneDetails:
{
Description: Details of capabilities available to a SKU in specific zones. ,
Required: False ,
}
[
{
name:
{
Description: The set of zones that the SKU is available in with the specified capabilities. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: A list of capabilities that are available for the SKU in the specified list of zones. ,
Required: False ,
}
[
{
name:
{
Description: An invariant to describe the feature. ,
Required: False ,
}
string ,
value:
{
Description: An invariant if the feature is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The api versions that support this SKU. ,
Required: False ,
}
[
string ,
]
,
costs:
{
Description: Metadata for retrieving price info. ,
Required: False ,
}
[
{
meterID:
{
Description: Used for querying price from commerce. ,
Required: False ,
}
string ,
quantity:
{
Description: The multiplier is needed to extend the base metered cost. ,
Format: int64 ,
Required: False ,
}
integer ,
extendedUnit:
{
Description: An invariant to show the extended unit. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: A name value pair to describe the capability. ,
Required: False ,
}
[
{
name:
{
Description: An invariant to describe the feature. ,
Required: False ,
}
string ,
value:
{
Description: An invariant if the feature is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. ,
Enum:
{
Location: No description available. ,
Zone: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
restrictionInfo:
{
Description: The information about the restriction where the SKU cannot be used. ,
Required: False ,
}
{
locations:
{
Description: Locations where the SKU is restricted ,
Required: False ,
}
[
string ,
]
,
zones:
{
Description: List of availability zones where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
reasonCode:
{
Description: The reason for restriction. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_List (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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: User (user id path) for whom subscription is being created in form /users/{userId} ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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 ,
allowTracing:
{
Description: Determines whether tracing can be enabled ,
Required: False ,
}
boolean ,
}
,
}
,
notify:
{
Description: Notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy publisher portal. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Subscription details. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Subscription Update contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: User identifier path: /users/{userId} ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId} ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
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 when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing can be enabled ,
Required: False ,
}
boolean ,
}
,
}
,
notify:
{
Description: Notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy publisher portal. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Subscription details. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscription_ListSecrets (new)
Description :  Gets the specified Subscription keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 keys. ,
}
{
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TagResource_ListByService (new)
Description :  Lists a collection of resources associated with tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| isCurrent | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
tag:
{
Description: Tag associated with the resource. ,
Required: True ,
}
{
id:
{
Description: Tag identifier ,
Required: False ,
}
string ,
name:
{
Description: Tag Name ,
Required: False ,
}
string ,
}
,
api:
{
Description: API associated with the tag. ,
Required: False ,
}
{
id:
{
Description: API identifier in the form /apis/{apiId}. ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
operation:
{
Description: Operation associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the operation in form /operations/{operationId}. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
apiName:
{
Description: API Name. ,
Required: False ,
}
string ,
apiRevision:
{
Description: API Revision. ,
Required: False ,
}
string ,
apiVersion:
{
Description: API Version. ,
Required: False ,
}
string ,
description:
{
Description: Operation Description. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
product:
{
Description: Product associated with the tag. ,
Required: False ,
}
{
id:
{
Description: Identifier of the product in the form of /products/{productId} ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_ListByService (new)
Description :  Lists a collection of tags defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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 ,
scope:
{
Description: Scope like 'apis', 'products' or 'apis/{apiId} ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_GetEntityState (new)
Description :  Gets the entity state version of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_Get (new)
Description :  Gets the details of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_CreateOrUpdate (new)
Description :  Creates a tag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to Create Tag operation. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_Update (new)
Description :  Updates the details of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to Create Tag operation. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tag_Delete (new)
Description :  Deletes specific tag of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_ListByService (new)
Description :  Returns list of access infos - for Git and Management endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: Not used ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: AccessInformation entity contract properties. ,
Required: False ,
}
{
id:
{
Description: Access Information type ('access' or 'gitAccess') ,
Required: False ,
}
string ,
principalId:
{
Description: Principal (User) Identifier. ,
Required: False ,
}
string ,
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_GetEntityTag (new)
Description :  Tenant access metadata
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_Get (new)
Description :  Get tenant access information details without secrets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tenant Settings. ,
}
{
properties:
{
Description: AccessInformation entity contract properties. ,
Required: False ,
}
{
id:
{
Description: Access Information type ('access' or 'gitAccess') ,
Required: False ,
}
string ,
principalId:
{
Description: Principal (User) Identifier. ,
Required: False ,
}
string ,
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_Create (new)
Description :  Update tenant access information details.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to retrieve the Tenant Access Information. ,
Required: True ,
}
{
properties:
{
Description: Tenant access information update parameter properties. ,
Required: False ,
}
{
principalId:
{
Description: Principal (User) Identifier. ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Settings. ,
}
{
properties:
{
Description: AccessInformation entity contract properties. ,
Required: False ,
}
{
id:
{
Description: Access Information type ('access' or 'gitAccess') ,
Required: False ,
}
string ,
principalId:
{
Description: Principal (User) Identifier. ,
Required: False ,
}
string ,
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_Update (new)
Description :  Update tenant access information details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to retrieve the Tenant Access Information. ,
Required: True ,
}
{
properties:
{
Description: Tenant access information update parameter properties. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Settings. ,
}
{
properties:
{
Description: AccessInformation entity contract properties. ,
Required: False ,
}
{
id:
{
Description: Access Information type ('access' or 'gitAccess') ,
Required: False ,
}
string ,
principalId:
{
Description: Principal (User) Identifier. ,
Required: False ,
}
string ,
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_RegeneratePrimaryKey (new)
Description :  Regenerate primary access key
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_RegenerateSecondaryKey (new)
Description :  Regenerate secondary access key
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccess_ListSecrets (new)
Description :  Get tenant access information details.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tenant access information contract of the API Management service. ,
}
{
id:
{
Description: Access Information type ('access' or 'gitAccess') ,
Required: False ,
}
string ,
principalId:
{
Description: Principal (User) Identifier. ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
enabled:
{
Description: Determines whether direct access is enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccessGit_RegeneratePrimaryKey (new)
Description :  Regenerate primary access key for GIT.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantAccessGit_RegenerateSecondaryKey (new)
Description :  Regenerate secondary access key for GIT.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{configurationName}/deploy
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Deploy Configuration parameters. ,
Required: True ,
}
{
properties:
{
Description: Deploy Configuration Parameter contract properties. ,
Required: False ,
}
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{configurationName}/save
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Save Configuration parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Save Configuration Parameters. ,
Required: False ,
}
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{configurationName}/validate
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Validate Configuration parameters. ,
Required: True ,
}
{
properties:
{
Description: Deploy Configuration Parameter contract properties. ,
Required: False ,
}
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantConfiguration_GetSyncState (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/{configurationName}/syncState
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties returned Tenant Configuration Sync State check. ,
Required: False ,
}
{
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 ,
lastOperationId:
{
Description: Most recent tenant configuration operation identifier ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_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. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| groups | expand | | |
 ,
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: Detailed Group in response. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_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/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: User details. ,
}
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_CreateOrUpdate (new)
Description :  Creates or Updates a user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: User entity create contract properties. ,
Required: False ,
}
{
email:
{
Description: Email address. Must not be empty and must be unique within the service instance. ,
Required: True ,
}
string ,
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
password:
{
Description: User Password. If no value is provided, a default password is generated. ,
Required: False ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy portal. ,
Enum:
{
portal: User create request was sent by legacy developer portal. ,
developerPortal: User create request was sent by new developer portal. ,
}
,
Required: False ,
}
enum ,
confirmation:
{
Description: Determines the type of confirmation e-mail that will be sent to the newly created user. ,
Enum:
{
signup: Send an e-mail to the user confirming they have successfully signed up. ,
invite: Send an e-mail inviting the user to sign-up and complete registration. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
notify:
{
Description: Send an Email notification to the User. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: User details. ,
}
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: User details. ,
}
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_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/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: User entity update contract properties. ,
Required: False ,
}
{
email:
{
Description: Email address. Must not be empty and must be unique within the service instance. ,
Required: False ,
}
string ,
password:
{
Description: User Password. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: User details. ,
}
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_Delete (new)
Description :  Deletes specific user.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
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 ,
notify:
{
Description: Send an Account Closed Email notification to the User. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy publisher portal. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_GenerateSsoUrl (new)
Description :  Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UserGroup_List (new)
Description :  Lists all user groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UserSubscription_List (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/{userId}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UserSubscription_Get (new)
Description :  Gets the specified Subscription entity associated with a particular user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UserIdentities_List (new)
Description :  List of all user identities.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/identities
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
User_GetSharedAccessToken (new)
Description :  Gets the Shared Access Authorization Token for the User.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create Authorization Token parameters. ,
Required: True ,
}
{
properties:
{
Description: User Token Parameter contract properties. ,
Required: False ,
}
{
keyType:
{
Description: The Key to be used to generate token for user. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: True ,
}
enum ,
expiry:
{
Description: The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UserConfirmationPassword_Send (new)
Description :  Sends confirmation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy publisher portal. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceBackend_ListByWorkspace (new)
Description :  Lists a collection of backends in the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Backend values. ,
Required: False ,
}
[
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceBackend_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the backend specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceBackend_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}/workspaces/{workspaceId}/backends/{backendId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceBackend_CreateOrUpdate (new)
Description :  Creates or Updates a backend.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceBackend_Update (new)
Description :  Updates an existing backend.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Backend entity update contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: True ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceBackend_Delete (new)
Description :  Deletes the specified backend.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
backendId:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceCertificate_ListByWorkspace (new)
Description :  Lists a collection of all certificates in the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
 ,
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 ,
isKeyVaultRefreshFailed:
{
Description: When set to true, the response contains only certificates entities which failed refresh. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceCertificate_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the certificate specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceCertificate_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}/workspaces/{workspaceId}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceCertificate_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}/workspaces/{workspaceId}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
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 or Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Certificate create or update properties details. ,
Required: False ,
}
{
data:
{
Description: Base 64 encoded certificate using the application/x-pkcs12 representation. ,
Required: False ,
}
string ,
password:
{
Description: Password for the Certificate ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
secretIdentifier:
{
Description: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi ,
Required: False ,
}
string ,
identityClientId:
{
Description: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Certificate details. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ 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. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceCertificate_Delete (new)
Description :  Deletes specific certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceCertificate_RefreshSecret (new)
Description :  From KeyVault, Refresh the certificate being used for authentication with the backend.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}/refreshSecret
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Certificate properties details. ,
Required: False ,
}
{
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 ,
keyVault:
{
Description: KeyVault location details of the certificate. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceDiagnostic_ListByWorkspace (new)
Description :  Lists all diagnostics in the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceDiagnostic_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Diagnostic specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceDiagnostic_Get (new)
Description :  Gets the details of the Diagnostic specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceDiagnostic_CreateOrUpdate (new)
Description :  Creates a new Diagnostic or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceDiagnostic_Update (new)
Description :  Updates the details of the Diagnostic specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Diagnostic Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: False ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceDiagnostic_Delete (new)
Description :  Deletes the specified Diagnostic.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiDiagnostic_ListByWorkspace (new)
Description :  Lists all diagnostics of an API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiDiagnostic_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiDiagnostic_Get (new)
Description :  Gets the details of the Diagnostic for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiDiagnostic_CreateOrUpdate (new)
Description :  Creates a new Diagnostic for an API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiDiagnostic_Update (new)
Description :  Updates the details of the Diagnostic for an API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Diagnostic Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: False ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Diagnostic details. ,
}
{
properties:
{
Description: Diagnostic entity contract properties. ,
Required: False ,
}
{
alwaysLog:
{
Description: Specifies for what type of messages sampling settings should not apply. ,
Enum:
{
allErrors: Always log all erroneous request regardless of sampling settings. ,
}
,
Required: False ,
}
enum ,
loggerId:
{
Description: Resource Id of a target logger. ,
Required: True ,
}
string ,
sampling:
{
Description: Sampling settings for Diagnostic. ,
Required: False ,
}
{
samplingType:
{
Description: Sampling type. ,
Enum:
{
fixed: Fixed-rate sampling. ,
}
,
Required: False ,
}
enum ,
percentage:
{
Description: Rate of sampling for fixed-rate sampling. ,
Format: double ,
Required: False ,
}
number ,
}
,
frontend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
backend:
{
Description: Diagnostic settings for incoming/outgoing HTTP messages to the Backend ,
Required: False ,
}
{
request:
{
Description: Diagnostic settings for request. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
response:
{
Description: Diagnostic settings for response. ,
Required: False ,
}
{
headers:
{
Description: Array of HTTP Headers to log. ,
Required: False ,
}
[
string ,
]
,
body:
{
Description: Body logging settings. ,
Required: False ,
}
{
bytes:
{
Description: Number of request body bytes to log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataMasking:
{
Description: Data masking settings. ,
Required: False ,
}
{
queryParams:
{
Description: Masking settings for Url query parameters ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
headers:
{
Description: Masking settings for headers ,
Required: False ,
}
[
{
value:
{
Description: The name of an entity to mask (e.g. a name of a header or a query parameter). ,
Required: False ,
}
string ,
mode:
{
Description: Data masking mode. ,
Enum:
{
Mask: Mask the value of an entity. ,
Hide: Hide the presence of an entity. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
largeLanguageModel:
{
Description: Large Language Models diagnostic settings ,
Required: False ,
}
{
logs:
{
Description: Specifies whether default diagnostic should be enabled for Large Language Models or not. ,
Enum:
{
enabled: Default LLM logs are enabled. ,
disabled: Default LLM logs are disabled. ,
}
,
Required: False ,
}
enum ,
requests:
{
Description: Diagnostic settings for Large Language Models requests. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
responses:
{
Description: Diagnostic settings for Large Language Models responses. ,
Required: False ,
}
{
messages:
{
Description: Specifies which message should be logged. Currently there is only 'all' option. ,
Enum:
{
all: Log all messages. ,
}
,
Required: False ,
}
enum ,
maxSizeInBytes:
{
Description: Maximum size of message to logs in bytes. The default size is 32KB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
logClientIp:
{
Description: Log the ClientIP. Default is false. ,
Required: False ,
}
boolean ,
httpCorrelationProtocol:
{
Description: Sets correlation protocol to use for Application Insights diagnostics. ,
Enum:
{
None: Do not read and inject correlation headers. ,
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. ,
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context. ,
}
,
Required: False ,
}
enum ,
verbosity:
{
Description: The verbosity level applied to traces emitted by trace policies. ,
Enum:
{
verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. ,
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. ,
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. ,
}
,
Required: False ,
}
enum ,
operationNameFormat:
{
Description: The format of the Operation Name for Application Insights telemetries. Default is Name. ,
Enum:
{
Name: API_NAME;rev=API_REVISION - OPERATION_NAME ,
Url: HTTP_VERB URL ,
}
,
Required: False ,
}
enum ,
metrics:
{
Description: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiDiagnostic_Delete (new)
Description :  Deletes the specified Diagnostic from an API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
diagnosticId:
{
Description: Diagnostic identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceLogger_ListByWorkspace (new)
Description :  Lists a collection of loggers in the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Logger values. ,
Required: False ,
}
[
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceLogger_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the logger specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceLogger_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}/workspaces/{workspaceId}/loggers/{loggerId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceLogger_CreateOrUpdate (new)
Description :  Creates or Updates a logger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceLogger_Update (new)
Description :  Updates an existing logger.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Logger entity update contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: Logger credentials. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
properties:
{
Description: Logger entity contract properties. ,
Required: False ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
applicationInsights: Azure Application Insights as log destination. ,
azureMonitor: Azure Monitor ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
resourceId:
{
Description: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceLogger_Delete (new)
Description :  Deletes the specified logger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
loggerId:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspace_ListByService (new)
Description :  Lists all workspaces of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

| description | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspace_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the workspace specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspace_Get (new)
Description :  Gets the details of the workspace specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Workspace details. ,
}
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspace_CreateOrUpdate (new)
Description :  Creates a new workspace or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Workspace details. ,
}
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Workspace details. ,
}
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspace_Update (new)
Description :  Updates the details of the workspace specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Workspace Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Workspace details. ,
}
{
properties:
{
Description: Workspace entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of the workspace. ,
Required: True ,
}
string ,
description:
{
Description: Description of the workspace. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspace_Delete (new)
Description :  Deletes the specified workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicy_ListByApi (new)
Description :  Get the policy configuration at the workspace level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the workspace policy specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicy_Get (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicy_Delete (new)
Description :  Deletes the policy configuration at the workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_ListByService (new)
Description :  Lists a collection of named values defined within a workspace in a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | 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 ,
isKeyVaultRefreshFailed:
{
Description: Query parameter to fetch named value entities based on refresh status. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_Get (new)
Description :  Gets the details of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_CreateOrUpdate (new)
Description :  Creates or updates named value.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: NamedValue entity contract properties for PUT operation. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
secretIdentifier:
{
Description: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi ,
Required: False ,
}
string ,
identityClientId:
{
Description: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_Update (new)
Description :  Updates the specific named value.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: NamedValue entity Update contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: False ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
secretIdentifier:
{
Description: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi ,
Required: False ,
}
string ,
identityClientId:
{
Description: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
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: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_Delete (new)
Description :  Deletes specific named value from the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_ListValue (new)
Description :  Gets the secret of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/listValue
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. ,
}
{
value:
{
Description: This is secret value of the NamedValue entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNamedValue_RefreshSecret (new)
Description :  Refresh the secret of the named value specified by its identifier.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/refreshSecret
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
namedValueId:
{
Description: Identifier of the NamedValue. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
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: NamedValue details. ,
}
{
properties:
{
Description: NamedValue entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
keyVault:
{
Description: KeyVault location details of the namedValue. ,
Required: False ,
}
{
lastStatus:
{
Description: Last time sync and refresh status of secret from key vault. ,
Required: False ,
}
{
code:
{
Description: Last status code for sync and refresh of secret from key vault. ,
Required: False ,
}
string ,
message:
{
Description: Details of the error else empty. ,
Required: False ,
}
string ,
timeStampUtc:
{
Description: Last time secret was accessed. 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 ,
}
,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGlobalSchema_ListByService (new)
Description :  Lists a collection of schemas registered with workspace in a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Global Schema Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGlobalSchema_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Schema specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGlobalSchema_Get (new)
Description :  Gets the details of the Schema specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Global Schema Contract details. ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGlobalSchema_CreateOrUpdate (new)
Description :  Creates new or updates existing specified Schema of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Global Schema Contract details. ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Global Schema Contract details. ,
}
{
properties:
{
Description: Properties of the Global Schema. ,
Required: False ,
}
{
schemaType:
{
Description: Schema Type. Immutable. ,
Enum:
{
xml: XML schema type. ,
json: Json schema type. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Free-form schema entity description. ,
Required: False ,
}
string ,
value:
{
Description: Json-encoded string for non json-based schema. ,
Required: False ,
}
string ,
document:
{
Description: Global Schema document object for json-based schema formats(e.g. json schema). ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGlobalSchema_Delete (new)
Description :  Deletes specific Schema.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotification_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}/workspaces/{workspaceId}/notifications
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Notification entity contract properties. ,
Required: False ,
}
{
title:
{
Description: Title of the Notification. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Notification. ,
Required: False ,
}
string ,
recipients:
{
Description: Recipient Parameter values. ,
Required: False ,
}
{
emails:
{
Description: List of Emails subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
users:
{
Description: List of Users subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotification_Get (new)
Description :  Gets the details of the Notification specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Notification entity contract properties. ,
Required: False ,
}
{
title:
{
Description: Title of the Notification. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Notification. ,
Required: False ,
}
string ,
recipients:
{
Description: Recipient Parameter values. ,
Required: False ,
}
{
emails:
{
Description: List of Emails subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
users:
{
Description: List of Users subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotification_CreateOrUpdate (new)
Description :  Create or Update API Management publisher notification for the workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Notification entity contract properties. ,
Required: False ,
}
{
title:
{
Description: Title of the Notification. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Notification. ,
Required: False ,
}
string ,
recipients:
{
Description: Recipient Parameter values. ,
Required: False ,
}
{
emails:
{
Description: List of Emails subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
users:
{
Description: List of Users subscribed for the notification. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientUser_ListByNotification (new)
Description :  Gets the list of the Notification Recipient User subscribed to the notification.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Recipient User entity contract properties. ,
Required: False ,
}
{
userId:
{
Description: API Management UserId subscribed to notification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientUser_CheckEntityExists (new)
Description :  Determine if the Notification Recipient User is subscribed to the notification.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientUser_CreateOrUpdate (new)
Description :  Adds the API Management User to the list of Recipients for the Notification.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Recipient User entity contract properties. ,
Required: False ,
}
{
userId:
{
Description: API Management UserId subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Recipient User entity contract properties. ,
Required: False ,
}
{
userId:
{
Description: API Management UserId subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientUser_Delete (new)
Description :  Removes the API Management user from the list of Notification.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientEmail_ListByNotification (new)
Description :  Gets the list of the Notification Recipient Emails subscribed to a notification.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Recipient Email contract properties. ,
Required: False ,
}
{
email:
{
Description: User Email subscribed to notification. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientEmail_CheckEntityExists (new)
Description :  Determine if Notification Recipient Email subscribed to the notification.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
email:
{
Description: Email identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientEmail_CreateOrUpdate (new)
Description :  Adds the Email address to the list of Recipients for the Notification.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
email:
{
Description: Email identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Recipient Email contract properties. ,
Required: False ,
}
{
email:
{
Description: User Email subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Recipient Email contract properties. ,
Required: False ,
}
{
email:
{
Description: User Email subscribed to notification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceNotificationRecipientEmail_Delete (new)
Description :  Removes the email from the list of Notification.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
notificationName:
{
Description: Notification Name Identifier. ,
Required: True ,
}
string ,
email:
{
Description: Email identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicyFragment_ListByService (new)
Description :  Gets all policy fragments defined within a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
 ,
Required: False ,
}
string ,
$orderby:
{
Description: OData order by query option. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: Policy fragment contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicyFragment_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of a policy fragment.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicyFragment_Get (new)
Description :  Gets a policy fragment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
format:
{
Description: Policy fragment content format. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy fragment contract details. ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicyFragment_CreateOrUpdate (new)
Description :  Creates or updates a policy fragment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy fragment contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Policy fragment contract details. ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: Policy fragment contract details. ,
}
{
properties:
{
Description: Properties of the Policy Fragment. ,
Required: False ,
}
{
value:
{
Description: Contents of the policy fragment. ,
Required: True ,
}
string ,
description:
{
Description: Policy fragment description. ,
Required: False ,
}
string ,
format:
{
Description: Format of the policy fragment content. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicyFragment_Delete (new)
Description :  Deletes a policy fragment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspacePolicyFragment_ListReferences (new)
Description :  Lists policy resources that reference the policy fragment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}/listReferences
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
id:
{
Description: A resource identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of resources. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroup_ListByService (new)
Description :  Lists a collection of groups defined within a workspace in a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroup_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroup_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}/workspaces/{workspaceId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroup_CreateOrUpdate (new)
Description :  Creates or Updates a group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to Create Group operation. ,
Required: False ,
}
{
displayName:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. ,
Required: False ,
}
string ,
type:
{
Description: Group type. ,
Enum:
{
custom: No description available. ,
system: No description available. ,
external: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroup_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}/workspaces/{workspaceId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Group entity update contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Group name. ,
Required: False ,
}
string ,
description:
{
Description: Group description. ,
Required: False ,
}
string ,
type:
{
Description: Group type. ,
Enum:
{
custom: No description available. ,
system: No description available. ,
external: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
properties:
{
Description: Group entity contract properties. ,
Required: False ,
}
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroup_Delete (new)
Description :  Deletes specific group of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroupUser_List (new)
Description :  Lists a collection of user entities associated with the group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroupUser_CheckEntityExists (new)
Description :  Checks that user entity specified by identifier is associated with the group entity.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroupUser_Create (new)
Description :  Add existing user to existing group
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: User entity contract properties. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
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 ,
groups:
{
Description: Collection of groups user is part of. ,
Required: False ,
}
[
{
displayName:
{
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. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceGroupUser_Delete (new)
Description :  Remove existing user from existing group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
userId:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_List (new)
Description :  Lists all subscriptions of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_Get (new)
Description :  Gets the specified Subscription entity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_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}/workspaces/{workspaceId}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: User (user id path) for whom subscription is being created in form /users/{userId} ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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 ,
allowTracing:
{
Description: Determines whether tracing can be enabled ,
Required: False ,
}
boolean ,
}
,
}
,
notify:
{
Description: Notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy publisher portal. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Subscription details. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_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}/workspaces/{workspaceId}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Subscription Update contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: User identifier path: /users/{userId} ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId} ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
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 when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing can be enabled ,
Required: False ,
}
boolean ,
}
,
}
,
notify:
{
Description: Notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
appType:
{
Description: Determines the type of application which send the create user request. Default is legacy publisher portal. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Subscription details. ,
}
{
properties:
{
Description: Subscription contract properties. ,
Required: False ,
}
{
ownerId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. ,
Required: False ,
}
string ,
scope:
{
Description: Scope like /products/{productId} or /apis or /apis/{apiId}. ,
Required: True ,
}
string ,
displayName:
{
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: True ,
}
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 setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator when the state is changed to the 'rejected'. ,
Required: False ,
}
string ,
allowTracing:
{
Description: Determines whether tracing is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_Delete (new)
Description :  Deletes the specified subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_RegeneratePrimaryKey (new)
Description :  Regenerates primary key of existing subscription of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_RegenerateSecondaryKey (new)
Description :  Regenerates secondary key of existing subscription of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceSubscription_ListSecrets (new)
Description :  Gets the specified Subscription keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/listSecrets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 keys. ,
}
{
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiVersionSet_ListByService (new)
Description :  Lists a collection of API Version Sets in the specified workspace with a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
 ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiVersionSet_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the Api Version Set specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiVersionSet_Get (new)
Description :  Gets the details of the Api Version Set specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiVersionSet_CreateOrUpdate (new)
Description :  Creates or Updates a Api Version Set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: API Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ 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 Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiVersionSet_Update (new)
Description :  Updates the details of the Api VersionSet specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Parameters to update or create an API Version Set Contract. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Version Set Contract details. ,
}
{
properties:
{
Description: API VersionSet contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Name of API Version Set ,
Required: True ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiVersionSet_Delete (new)
Description :  Deletes specific Api Version Set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
versionSetId:
{
Description: Api Version Set identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApi_ListByService (new)
Description :  Lists all APIs of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
 ,
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 ,
tags:
{
Description: Include tags in the response. ,
Required: False ,
}
string ,
expandApiVersionSet:
{
Description: Include full ApiVersionSet resource in response ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApi_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApi_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}/workspaces/{workspaceId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApi_CreateOrUpdate (new)
Description :  Creates new or updates existing specified API of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: API entity create of update properties. ,
Required: False ,
}
{
value:
{
Description: Content value when Importing an API. ,
Required: False ,
}
string ,
format:
{
Description: Format of the Content in which the API is getting imported. New formats can be added in the future ,
Enum:
{
wadl-xml: The contents are inline and Content type is a WADL document. ,
wadl-link-json: The WADL document is hosted on a publicly accessible internet address. ,
swagger-json: The contents are inline and Content Type is a OpenAPI 2.0 JSON Document. ,
swagger-link-json: The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address. ,
wsdl: The contents are inline and the document is a WSDL/Soap document. ,
wsdl-link: The WSDL document is hosted on a publicly accessible internet address. ,
openapi: The contents are inline and Content Type is a OpenAPI 3.0 YAML Document. ,
openapi+json: The contents are inline and Content Type is a OpenAPI 3.0 JSON Document. ,
openapi-link: The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address. ,
openapi+json-link: The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address. ,
graphql-link: The GraphQL API endpoint hosted on a publicly accessible internet address. ,
odata: The contents are inline and Content Type is a OData XML Document. ,
odata-link: The OData metadata document hosted on a publicly accessible internet address. ,
grpc: The contents are inline and Content Type is a gRPC protobuf file. ,
grpc-link: The gRPC protobuf file is hosted on a publicly accessible internet address. ,
}
,
Required: False ,
}
enum ,
wsdlSelector:
{
Description: Criteria to limit import of WSDL to a subset of the document. ,
Required: False ,
}
{
wsdlServiceName:
{
Description: Name of service to import from WSDL ,
Required: False ,
}
string ,
wsdlEndpointName:
{
Description: Name of endpoint(port) to import from WSDL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: Type of API to create. * `http` creates a REST API * `soap` creates a SOAP pass-through API * `websocket` creates websocket API * `graphql` creates GraphQL API. New types can be added in the future. ,
Enum:
{
http: Imports a SOAP API having a RESTful front end. ,
soap: Imports the SOAP API having a SOAP front end. ,
websocket: Imports the API having a Websocket front end. ,
graphql: Imports the API having a GraphQL front end. ,
odata: Imports the API having a OData front end. ,
grpc: Imports the API having a gRPC front end. ,
}
,
Required: False ,
}
enum ,
translateRequiredQueryParameters:
{
Description: Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query' ,
Enum:
{
template: Translates required query parameters to template ones. Is a default value ,
query: Leaves required query parameters as they are (no translation done). ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API details. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API details. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApi_Update (new)
Description :  Updates the specified API of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
parameters:
{
Description: API Update Contract parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API entity that can be updated. ,
Required: False ,
}
{
displayName:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: API entity contract properties. ,
Required: False ,
}
{
sourceApiId:
{
Description: API identifier of the source API. ,
Required: False ,
}
string ,
displayName:
{
Description: API name. Must be 1 to 300 characters long. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. ,
Required: False ,
}
string ,
path:
{
Description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. ,
Required: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
apiVersionSet:
{
Description: Version set details ,
Required: False ,
}
{
id:
{
Description: Identifier for existing API Version Set. Omit this value to create a new Version Set. ,
Required: False ,
}
string ,
name:
{
Description: The display Name of the API Version Set. ,
Required: False ,
}
string ,
description:
{
Description: Description of API Version Set. ,
Required: False ,
}
string ,
versioningScheme:
{
Description: An value that determines where the API Version identifier will be located in a HTTP request. ,
Enum:
{
Segment: The API Version is passed in a path segment. ,
Query: The API Version is passed in a query parameter. ,
Header: The API Version is passed in a HTTP header. ,
}
,
Required: False ,
}
enum ,
versionQueryName:
{
Description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ,
Required: False ,
}
string ,
versionHeaderName:
{
Description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApi_Delete (new)
Description :  Deletes the specified API of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
deleteRevisions:
{
Description: Delete all revisions of the Api. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRevision_ListByService (new)
Description :  Lists all revisions of an API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/revisions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
apiId:
{
Description: Identifier of the API Revision. ,
Required: False ,
}
string ,
apiRevision:
{
Description: Revision number of API. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API Revision was created. 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 ,
updatedDateTime:
{
Description: The time the API Revision were updated. 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 ,
description:
{
Description: Description of the API Revision. ,
Required: False ,
}
string ,
privateUrl:
{
Description: Gateway URL for accessing the non-current API Revision. ,
Required: False ,
}
string ,
isOnline:
{
Description: Indicates if API revision is the current api revision. ,
Required: False ,
}
boolean ,
isCurrent:
{
Description: Indicates if API revision is accessible via the gateway. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRelease_ListByService (new)
Description :  Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRelease_GetEntityTag (new)
Description :  Returns the etag of an API release.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRelease_Get (new)
Description :  Returns the details of an API release.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRelease_CreateOrUpdate (new)
Description :  Creates a new Release for the API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRelease_Update (new)
Description :  Updates the details of the release of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: API Release Update parameters. ,
Required: True ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: ApiRelease details. ,
}
{
properties:
{
Description: ApiRelease entity contract properties. ,
Required: False ,
}
{
apiId:
{
Description: Identifier of the API the release belongs to. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The time the API was released. 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 ,
updatedDateTime:
{
Description: The time the API release was updated. ,
Format: date-time ,
Required: False ,
}
string ,
notes:
{
Description: Release Notes ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiRelease_Delete (new)
Description :  Deletes the specified release in the API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace 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 ,
releaseId:
{
Description: Release identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperation_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}/workspaces/{workspaceId}/apis/{apiId}/operations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | 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 ,
tags:
{
Description: Include tags in the response. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperation_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API operation specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperation_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}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperation_CreateOrUpdate (new)
Description :  Creates a new operation in the API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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 ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: API Operation details. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ 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. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperation_Update (new)
Description :  Updates the details of the operation in the API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: API Operation Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Operation entity that can be updated. ,
Required: False ,
}
{
displayName:
{
Description: Operation Name. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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. ,
}
{
properties:
{
Description: Properties of the Operation Contract. ,
Required: False ,
}
{
displayName:
{
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 ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperation_Delete (new)
Description :  Deletes the specified operation in the API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperationPolicy_ListByOperation (new)
Description :  Get the list of policy configuration at the API Operation level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperationPolicy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API operation policy specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperationPolicy_Get (new)
Description :  Get the policy configuration at the API Operation level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperationPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the API Operation level.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiOperationPolicy_Delete (new)
Description :  Deletes the policy configuration at the Api Operation.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiPolicy_ListByApi (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiPolicy_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the API policy specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiPolicy_Get (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiPolicy_Delete (new)
Description :  Deletes the policy configuration at the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiSchema_ListByApi (new)
Description :  Get the schema configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: API Schema Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiSchema_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the schema specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiSchema_Get (new)
Description :  Get the schema configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 Schema Contract details. ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiSchema_CreateOrUpdate (new)
Description :  Creates or updates schema configuration for the API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: The schema contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API Schema Contract details. ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
location:
{
Description: Location header contains the URL where the status of the long running operation can be checked ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked ,
}
string ,
}
,
$schema:
{
Description: API Schema Contract details. ,
}
{
properties:
{
Description: Properties of the API Schema. ,
Required: False ,
}
{
contentType:
{
Description: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. ,
Required: True ,
}
string ,
document:
{
Description: Create or update Properties of the API Schema Document. ,
Required: True ,
}
{
value:
{
Description: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ,
Required: False ,
}
string ,
definitions:
{
Description: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. ,
Required: False ,
}
object ,
components:
{
Description: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: The provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceApiSchema_Delete (new)
Description :  Deletes the schema configuration at the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema id identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
force:
{
Description: If true removes all references to the schema before deleting it. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProduct_ListByService (new)
Description :  Lists a collection of products in the specified workspace in a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
 ,
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 ,
tags:
{
Description: Products which are part of a specific tag. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProduct_GetEntityTag (new)
Description :  Gets the entity state (Etag) version of the product specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProduct_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}/workspaces/{workspaceId}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProduct_CreateOrUpdate (new)
Description :  Creates or Updates a product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
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 ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProduct_Update (new)
Description :  Update existing product details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
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 ,
}
{
properties:
{
Description: Product entity Update contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
properties:
{
Description: Product entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Product name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProduct_Delete (new)
Description :  Delete product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
deleteSubscriptions:
{
Description: Delete existing subscriptions associated with the product or not. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProductPolicy_ListByProduct (new)
Description :  Get the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
count:
{
Description: Total record count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProductPolicy_GetEntityTag (new)
Description :  Get the ETag of the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProductPolicy_Get (new)
Description :  Get the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
format:
{
Description: Policy Export Format. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProductPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the Product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy Contract details. ,
}
{
properties:
{
Description: Properties of the Policy. ,
Required: False ,
}
{
value:
{
Description: Contents of the Policy as defined by the format. ,
Required: True ,
}
string ,
format:
{
Description: Format of the policyContent. ,
Enum:
{
xml: The contents are inline and Content type is an XML document. ,
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. ,
rawxml: The contents are inline and Content type is a non XML encoded policy document. ,
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceProductPolicy_Delete (new)
Description :  Deletes the policy configuration at the Product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceTag_ListByService (new)
Description :  Lists a collection of tags defined within a workspace in a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | 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 ,
scope:
{
Description: Scope like 'apis', 'products' or 'apis/{apiId} ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceTag_GetEntityState (new)
Description :  Gets the entity state version of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceTag_Get (new)
Description :  Gets the details of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceTag_CreateOrUpdate (new)
Description :  Creates a tag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to Create Tag operation. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceTag_Update (new)
Description :  Updates the details of the tag specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to Create Tag operation. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: Tag Contract details. ,
}
{
properties:
{
Description: Tag entity contract properties. ,
Required: False ,
}
{
displayName:
{
Description: Tag name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkspaceTag_Delete (new)
Description :  Deletes specific tag of the workspace in an API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
workspaceId:
{
Description: Workspace identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
tagId:
{
Description: Tag identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationStatus_Get (new)
Description :  Returns the current status of an async operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationStatuses/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationsResults_Get (new)
Description :  Returns operation results for long running operations executing DELETE or PATCH on the resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL for determining when an operation has completed. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}