Api Gateway Config Connection - List By Gateway

Reference

Service:: API Management

API Version:: 2024-05-01

List all API Management gateway config connections within a gateway.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
gatewayName	path	True	string	The name of the API Management gateway. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ApiManagementGatewayConfigConnectionListResult	The API Management gateway config connection list.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementListGatewayConfigConnection

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1",
      "name": "gcc-1",
      "type": "Microsoft.ApiManagement/gateways/configConnections",
      "etag": "AAAAAAAWN/4=",
      "properties": {
        "provisioningState": "Succeeded",
        "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
        "defaultHostname": "gcc-1-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net",
        "hostnames": [
          "gcc1standard-gw-1.gateway.eastus.azure-api.net"
        ]
      }
    },
    {
      "etag": "AAAAAAAWKwo=",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-2",
      "name": "gcc-2",
      "properties": {
        "provisioningState": "Succeeded",
        "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002",
        "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net"
      },
      "type": "Microsoft.ApiManagement/gateways/configConnetions"
    }
  ]
}

Definitions

Name	Description
ApiManagementGatewayConfigConnectionListResult	The response of the List API Management gateway operation.
ApiManagementGatewayConfigConnectionResource	A single API Management gateway resource in List or Get response.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ApiManagementGatewayConfigConnectionListResult

The response of the List API Management gateway operation.

Name	Type	Description
nextLink	string	Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
value	ApiManagementGatewayConfigConnectionResource[]	Result of the List API Management gateway config connection operation.

ApiManagementGatewayConfigConnectionResource

A single API Management gateway resource in List or Get response.

Name	Type	Description
etag	string	ETag of the resource.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.defaultHostname	string	The default hostname of the data-plane gateway.
properties.hostnames	string[]	The hostnames of the data-plane gateway to which requests can be sent.
properties.provisioningState	string	The current provisioning state of the API Management gateway config connection
properties.sourceId	string	The link to the API Management service workspace.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Share via