Api Gateway - Get

Reference

Service:: API Management

API Version:: 2024-05-01

Gets an API Management gateway resource description.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}?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	ApiManagementGatewayResource	Successfully got the API Management gateway Resource.
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

ApiManagementGatewayGetGateway

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway",
  "name": "example-gateway",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "owner": "v-aswmoh",
    "ReleaseName": "Z3"
  },
  "location": "East US",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-06-16T09:40:00.9453556Z",
    "frontend": {
      "defaultHostname": "example-gateway.eastus.gateway.azure-api.net"
    },
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "configurationApi": {
      "hostname": "example-gateway.eastus.configuration.gateway.azure-api.net"
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2021-06-16T09:40:00.7106733Z",
    "lastModifiedBy": "foo@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-20T06:33:09.6159006Z"
  }
}

Definitions

Name	Description
ApiGatewaySkuType	Name of the Sku.
ApiManagementGatewayResource	A single API Management gateway resource in List or Get response.
ApiManagementGatewaySkuProperties	API Management gateway resource SKU properties.
BackendConfiguration	Information regarding how the gateway should integrate with backend systems.
BackendSubnetConfiguration	Information regarding how the subnet to which the gateway should be injected.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FrontendConfiguration	Information regarding how the gateway should be exposed.
GatewayConfigurationApi	Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
systemData	Metadata pertaining to creation and last modification of the resource.
VirtualNetworkType	The type of VPN in which API Management gateway needs to be configured in.

ApiGatewaySkuType

Name of the Sku.

Name	Type	Description
Standard	string	Standard SKU of the API gateway.
WorkspaceGatewayPremium	string	Premium SKU of the API gateway to be used in Workspaces.
WorkspaceGatewayStandard	string	Standard SKU of the API gateway to be used in Workspaces.

ApiManagementGatewayResource

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

Name	Type	Description
etag	string	ETag of the resource.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.backend	BackendConfiguration	Information regarding how the gateway should integrate with backend systems.
properties.configurationApi	GatewayConfigurationApi	Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
properties.createdAtUtc	string	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.
properties.frontend	FrontendConfiguration	Information regarding how the gateway should be exposed.
properties.provisioningState	string	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.
properties.targetProvisioningState	string	The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
properties.virtualNetworkType	VirtualNetworkType	The type of VPN in which API Management gateway needs to be configured in.
sku	ApiManagementGatewaySkuProperties	SKU properties of the API Management gateway.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type for API Management resource is set to Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

API Management gateway resource SKU properties.

Name	Type	Description
capacity	integer	Capacity of the SKU (number of deployed units of the SKU)
name	ApiGatewaySkuType	Name of the Sku.

BackendConfiguration

Information regarding how the gateway should integrate with backend systems.

Name	Type	Description
subnet	BackendSubnetConfiguration	The default hostname of the data-plane gateway to which requests can be sent.

BackendSubnetConfiguration

Information regarding how the subnet to which the gateway should be injected.

Name	Type	Description
id	string	The ARM ID of the subnet in which the backend systems are hosted.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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.

FrontendConfiguration

Information regarding how the gateway should be exposed.

Name	Type	Description
defaultHostname	string	The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.

GatewayConfigurationApi

Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.

Name	Type	Description
hostname	string	Hostname to which the agent connects to propagate configuration to the cloud.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

VirtualNetworkType

The type of VPN in which API Management gateway needs to be configured in.

Name	Type	Description
External	string	The API Management gateway is part of Virtual Network and it is accessible from Internet.
Internal	string	The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network.
None	string	The API Management gateway is not part of any Virtual Network.

Share via