Microsoft.Web (stable:2025-03-01)

2025/10/23 • 1 updated methods

AppServicePlans_GetServerFarmInstanceDetails (updated)
Description :  Description for Get the instance details for an app service plan.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AppServicePlans_GetServerFarmInstanceDetails",
  "$responses": {
    "200": {
      "$properties": {
        "@added_d4e617b765a543d2a1b42c56e671eb0e": {
          "#name": "serverFarmName",
          "Description": "The server farm name.",
          "Required": false,
          "Type": "string"
        },
        "@added_bdd063cb0daa417c9c4f104e9906adfb": {
          "#name": "instances",
          "Description": "The list of server farm instances.",
          "Required": false,
          "Type": "array",
          "$items": {
            "Description": "Represents details of a single instance in a server farm.",
            "Type": "object",
            "$properties": [
              {
                "#name": "instanceName",
                "Description": "The instance name.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "ipAddress",
                "Description": "The instance IP address.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "status",
                "Description": "The instance status.",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        },
        "@added_0bd954ccfb0f44f88f7994923bd0090e": {
          "#name": "instanceCount",
          "Description": "The total number of instances.",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@removed_55c86f273cc34e87889fb71ef2511e58": {
          "#name": "properties",
          "Description": "ServerFarmInstanceDetails resource specific properties",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "serverFarmName",
              "Description": "The server farm name.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "instances",
              "Description": "The list of server farm instances.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Represents details of a single instance in a server farm.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "instanceName",
                    "Description": "The instance name.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "ipAddress",
                    "Description": "The instance IP address.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "status",
                    "Description": "The instance status.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            },
            {
              "#name": "instanceCount",
              "Description": "The total number of instances.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serverFarmName:
{
Description: The server farm name. ,
Required: False ,
}
string ,
instances:
{
Description: The list of server farm instances. ,
Required: False ,
}
[
{
instanceName:
{
Description: The instance name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The instance IP address. ,
Required: False ,
}
string ,
status:
{
Description: The instance status. ,
Required: False ,
}
string ,
}
,
]
,
instanceCount:
{
Description: The total number of instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}