{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-api-management/json-schema/microsoft-azure-api-management-api-management-gateway-list-result-schema.json",
  "title": "ApiManagementGatewayListResult",
  "description": "The response of the List API Management gateway operation.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-api-management-apigateway-api-openapi.yml#/components/schemas/ApiManagementGatewayListResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ApiManagementGatewayResource"
      },
      "description": "Result of the List API Management gateway operation."
    },
    "nextLink": {
      "type": "string",
      "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services."
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "ApiManagementGatewayBaseProperties": {
      "type": "object",
      "properties": {
        "provisioningState": {
          "type": "string",
          "description": "The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.",
          "readOnly": true
        },
        "targetProvisioningState": {
          "type": "string",
          "description": "The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.",
          "readOnly": true
        },
        "createdAtUtc": {
          "type": "string",
          "format": "date-time",
          "description": "Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.",
          "readOnly": true
        },
        "frontend": {
          "$ref": "#/$defs/FrontendConfiguration",
          "description": "Information regarding how the gateway should be exposed."
        },
        "backend": {
          "$ref": "#/$defs/BackendConfiguration",
          "description": "Information regarding how the gateway should integrate with backend systems."
        },
        "configurationApi": {
          "$ref": "#/$defs/GatewayConfigurationApi",
          "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU."
        },
        "virtualNetworkType": {
          "type": "string",
          "description": "The type of VPN in which API Management gateway needs to be configured in. ",
          "enum": [
            "None",
            "External",
            "Internal"
          ],
          "x-ms-enum": {
            "name": "VirtualNetworkType",
            "modelAsString": true,
            "values": [
              {
                "value": "None",
                "description": "The API Management gateway is not part of any Virtual Network."
              },
              {
                "value": "External",
                "description": "The API Management gateway is part of Virtual Network and it is accessible from Internet."
              },
              {
                "value": "Internal",
                "description": "The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network."
              }
            ]
          }
        }
      },
      "description": "Base Properties of an API Management gateway resource description."
    },
    "ApiManagementGatewayProperties": {
      "type": "object",
      "properties": {},
      "allOf": [
        {
          "$ref": "#/$defs/ApiManagementGatewayBaseProperties"
        }
      ],
      "description": "Properties of an API Management gateway resource description."
    },
    "ApiManagementGatewayResource": {
      "type": "object",
      "properties": {
        "properties": {
          "x-ms-client-flatten": true,
          "$ref": "#/$defs/ApiManagementGatewayProperties",
          "description": "Properties of the API Management gateway."
        },
        "sku": {
          "$ref": "#/$defs/ApiManagementGatewaySkuProperties",
          "description": "SKU properties of the API Management gateway."
        },
        "systemData": {
          "$ref": "#/$defs/systemData",
          "description": "Metadata pertaining to creation and last modification of the resource.",
          "readOnly": true
        },
        "location": {
          "type": "string",
          "description": "Resource location.",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        },
        "etag": {
          "type": "string",
          "description": "ETag of the resource.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ApimResource"
        }
      ],
      "required": [
        "location",
        "sku",
        "properties"
      ],
      "description": "A single API Management gateway resource in List or Get response."
    },
    "ApiManagementGatewaySkuProperties": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the Sku.",
          "enum": [
            "Standard",
            "WorkspaceGatewayStandard",
            "WorkspaceGatewayPremium"
          ],
          "x-ms-enum": {
            "name": "ApiGatewaySkuType",
            "modelAsString": true,
            "values": [
              {
                "value": "Standard",
                "description": "Standard SKU of the API gateway."
              },
              {
                "value": "WorkspaceGatewayStandard",
                "description": "Standard SKU of the API gateway to be used in Workspaces."
              },
              {
                "value": "WorkspaceGatewayPremium",
                "description": "Premium SKU of the API gateway to be used in Workspaces."
              }
            ]
          }
        },
        "capacity": {
          "type": "integer",
          "format": "int32",
          "description": "Capacity of the SKU (number of deployed units of the SKU)"
        }
      },
      "required": [
        "name"
      ],
      "description": "API Management gateway resource SKU properties."
    },
    "ApimResource": {
      "type": "object",
      "description": "The Resource definition.",
      "properties": {
        "id": {
          "readOnly": true,
          "type": "string",
          "description": "Resource ID."
        },
        "name": {
          "type": "string",
          "description": "Resource name.",
          "readOnly": true
        },
        "type": {
          "readOnly": true,
          "type": "string",
          "description": "Resource type for API Management resource is set to Microsoft.ApiManagement."
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Resource tags."
        }
      },
      "x-ms-azure-resource": true
    },
    "BackendConfiguration": {
      "type": "object",
      "properties": {
        "subnet": {
          "$ref": "#/$defs/BackendSubnetConfiguration",
          "description": "The default hostname of the data-plane gateway to which requests can be sent."
        }
      },
      "description": "Information regarding how the gateway should integrate with backend systems."
    },
    "BackendSubnetConfiguration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ARM ID of the subnet in which the backend systems are hosted."
        }
      },
      "description": "Information regarding how the subnet to which the gateway should be injected."
    },
    "FrontendConfiguration": {
      "type": "object",
      "properties": {
        "defaultHostname": {
          "readOnly": true,
          "type": "string",
          "description": "The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU."
        }
      },
      "description": "Information regarding how the gateway should be exposed."
    },
    "GatewayConfigurationApi": {
      "type": "object",
      "properties": {
        "hostname": {
          "readOnly": true,
          "type": "string",
          "description": "Hostname to which the agent connects to propagate configuration to the cloud."
        }
      },
      "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU."
    },
    "systemData": {
      "type": "object",
      "description": "Metadata pertaining to creation and last modification of the resource.",
      "properties": {
        "createdBy": {
          "type": "string",
          "description": "The identity that created the resource."
        },
        "createdByType": {
          "type": "string",
          "description": "The type of identity that created the resource.",
          "enum": [
            "User",
            "Application",
            "ManagedIdentity",
            "Key"
          ],
          "x-ms-enum": {
            "name": "createdByType",
            "modelAsString": true
          }
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp of resource creation (UTC)."
        },
        "lastModifiedBy": {
          "type": "string",
          "description": "The identity that last modified the resource."
        },
        "lastModifiedByType": {
          "type": "string",
          "description": "The type of identity that last modified the resource.",
          "enum": [
            "User",
            "Application",
            "ManagedIdentity",
            "Key"
          ],
          "x-ms-enum": {
            "name": "createdByType",
            "modelAsString": true
          }
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp of resource last modification (UTC)"
        }
      },
      "readOnly": true
    }
  }
}