Microsoft.ApiManagement (preview:2023-05-01)

2025/09/08 • 4 updated methods

Backend_ListByService (updated)
Description :  Lists a collection of backends in the specified service instance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backend_ListByService",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "url",
                "Description": {
                  "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
                  "old": "Runtime Url of the Backend."
                },
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "protocol",
                "Description": {
                  "new": "Backend communication protocol. Required when backend type is 'Single'.",
                  "old": "Backend communication protocol."
                },
                "Required": {
                  "new": false,
                  "old": true
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
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: Properties of the Error Response. ,
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 ,
}
,
]
,
}
,
}
Backend_Get (updated)
Description :  Gets the details of the backend specified by its identifier.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backend_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "url",
            "Description": {
              "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
              "old": "Runtime Url of the Backend."
            },
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "protocol",
            "Description": {
              "new": "Backend communication protocol. Required when backend type is 'Single'.",
              "old": "Backend communication protocol."
            },
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ 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 when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Properties of the Error Response. ,
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 ,
}
,
]
,
}
,
}
Backend_CreateOrUpdate (updated)
Description :  Creates or Updates a backend.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backend_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "url",
            "Description": {
              "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
              "old": "Runtime Url of the Backend."
            },
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "protocol",
            "Description": {
              "new": "Backend communication protocol. Required when backend type is 'Single'.",
              "old": "Backend communication protocol."
            },
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "url",
            "Description": {
              "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
              "old": "Runtime Url of the Backend."
            },
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "protocol",
            "Description": {
              "new": "Backend communication protocol. Required when backend type is 'Single'.",
              "old": "Backend communication protocol."
            },
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    },
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "url",
            "Description": {
              "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
              "old": "Runtime Url of the Backend."
            },
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "protocol",
            "Description": {
              "new": "Backend communication protocol. Required when backend type is 'Single'.",
              "old": "Backend communication protocol."
            },
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ 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 when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
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. 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 when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP 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: Backend details. ,
}
{
properties:
{
Description: Backend entity contract properties. ,
Required: False ,
}
{
url:
{
Description: Runtime Url of the Backend. Required when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Properties of the Error Response. ,
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 ,
}
,
]
,
}
,
}
Backend_Update (updated)
Description :  Updates an existing backend.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backend_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "url",
            "Description": {
              "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
              "old": "Runtime Url of the Backend."
            }
          },
          {
            "#name": "protocol",
            "Description": {
              "new": "Backend communication protocol. Required when backend type is 'Single'.",
              "old": "Backend communication protocol."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "url",
            "Description": {
              "new": "Runtime Url of the Backend. Required when backend type is 'Single'.",
              "old": "Runtime Url of the Backend."
            },
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "protocol",
            "Description": {
              "new": "Backend communication protocol. Required when backend type is 'Single'.",
              "old": "Backend communication protocol."
            },
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ 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 when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
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 when backend type is 'Single'. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. Required when backend type is 'Single'. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Properties of the Error Response. ,
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 ,
}
,
]
,
}
,
}