Api Management Service - Get

Reference

Service:: API Management

API Version:: 2024-05-01

Gets an API Management service resource description.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
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	ApiManagementServiceResource	Successfully got the API Management Service 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

ApiManagementServiceGetMultiRegionInternalVnet

ApiManagementServiceGetService

ApiManagementServiceGetServiceHavingMsi

ApiManagementServiceGetMultiRegionInternalVnet

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementServiceGetService

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium",
  "name": "OGF-Z3-06162021-Premium",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "owner": "v-aswmoh",
    "ReleaseName": "Z3"
  },
  "location": "East US",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "publisherEmail": "string",
    "publisherName": "Test Premium",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-06-16T09:40:00.9453556Z",
    "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net",
    "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net",
    "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net",
    "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net",
    "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net",
    "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "ogf-z3-06162021-premium.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "gateway.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": true,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      },
      {
        "type": "DeveloperPortal",
        "hostName": "developer.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      },
      {
        "type": "Management",
        "hostName": "mgmt.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "13.92.130.49"
    ],
    "additionalLocations": [
      {
        "location": "East US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "zones": [],
        "publicIPAddresses": [
          "40.70.24.106"
        ],
        "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net",
        "disableGateway": false,
        "platformVersion": "stv2"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "None",
    "certificates": [],
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-12-01"
    },
    "publicNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName",
        "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
        "name": "privateEndpointProxyName",
        "properties": {
          "provisioningState": "Pending",
          "privateEndpoint": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
          },
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Please approve my request, thanks",
            "actionsRequired": "None"
          },
          "groupIds": [
            "Gateway"
          ]
        }
      }
    ],
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": {
        "principalId": "713784d2-ee37-412a-95f0-3768f397f82d",
        "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789"
      }
    }
  },
  "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"
  }
}

ApiManagementServiceGetServiceHavingMsi

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West Europe",
  "etag": "AAAAAAAENfI=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2020-12-18T11:11:47+00:00",
          "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "KeyVault"
      }
    ],
    "publicIPAddresses": [
      "13.94.xxx.188"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "External",
    "disableGateway": false
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a",
    "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
        "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3",
        "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf"
      }
    }
  }
}

Definitions

Name	Description
AdditionalLocation	Description of an additional API Management resource location.
ApiManagementServiceIdentity	Identity properties of the Api Management service resource.
ApiManagementServiceResource	A single API Management service resource in List or Get response.
ApiManagementServiceSkuProperties	API Management service resource SKU properties.
ApimIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
ApiVersionConstraint	Control Plane Apis version constraint for the API Management service.
ArmIdWrapper	A wrapper for an ARM resource id
CertificateConfiguration	Certificate configuration which consist of non-trusted intermediates and root certificates.
CertificateInformation	SSL certificate information.
CertificateSource	Certificate Source.
CertificateStatus	Certificate Status.
ConfigurationApi	Information regarding the Configuration API of the API Management service.
createdByType	The type of identity that created the resource.
developerPortalStatus	Status of developer portal in this API Management service.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HostnameConfiguration	Custom hostname configuration.
HostnameType	Hostname type.
LegacyApiState	Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'
LegacyPortalStatus	Status of legacy portal in the API Management service.
NatGatewayState	Property can be used to enable NAT Gateway for this API Management service.
PlatformVersion	Compute Platform Version running the service.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
PublicNetworkAccess	Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
RemotePrivateEndpointConnectionWrapper	Remote Private Endpoint Connection resource.
SkuType	Name of the Sku.
systemData	Metadata pertaining to creation and last modification of the resource.
UserIdentityProperties
VirtualNetworkConfiguration	Configuration of a virtual network to which API Management service is deployed.
VirtualNetworkType	The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

AdditionalLocation

Description of an additional API Management resource location.

Name	Type	Default value	Description
disableGateway	boolean	False	Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
gatewayRegionalUrl	string		Gateway URL of the API Management service in the Region.
location	string		The location name of the additional region among Azure Data center regions.
natGatewayState	NatGatewayState	Disabled	Property can be used to enable NAT Gateway for this API Management service.
outboundPublicIPAddresses	string[]		Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
platformVersion	PlatformVersion		Compute Platform Version running the service.
privateIPAddresses	string[]		Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
publicIPAddresses	string[]		Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
publicIpAddressId	string		Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
sku	ApiManagementServiceSkuProperties		SKU properties of the API Management service.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Virtual network configuration for the location.
zones	string[]		A list of availability zones denoting where the resource needs to come from.

ApiManagementServiceIdentity

Identity properties of the Api Management service resource.

Name	Type	Description
principalId	string	The principal id of the identity.
tenantId	string	The client tenant id of the identity.
type	ApimIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities	<string, UserIdentityProperties>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

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

Name	Type	Default value	Description
etag	string		ETag of the resource.
id	string		Resource ID.
identity	ApiManagementServiceIdentity		Managed service identity of the Api Management service.
location	string		Resource location.
name	string		Resource name.
properties.additionalLocations	AdditionalLocation[]		Additional datacenter locations of the API Management service.
properties.apiVersionConstraint	ApiVersionConstraint		Control Plane Apis version constraint for the API Management service.
properties.certificates	CertificateConfiguration[]		List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
properties.configurationApi	ConfigurationApi		Configuration API configuration of the API Management service.
properties.createdAtUtc	string		Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.customProperties	object		Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service. Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1, 2018 and `False` otherwise. Http2 setting's default value is `False`. You can disable any of the following ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalStatus	developerPortalStatus	Enabled	Status of developer portal in this API Management service.
properties.developerPortalUrl	string		DEveloper Portal endpoint URL of the API Management service.
properties.disableGateway	boolean	False	Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
properties.enableClientCertificate	boolean	False	Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
properties.gatewayRegionalUrl	string		Gateway URL of the API Management service in the Default Region.
properties.gatewayUrl	string		Gateway URL of the API Management service.
properties.hostnameConfigurations	HostnameConfiguration[]		Custom hostname configuration of the API Management service.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status of legacy portal in the API Management service.
properties.managementApiUrl	string		Management API endpoint URL of the API Management service.
properties.natGatewayState	NatGatewayState	Disabled	Property can be used to enable NAT Gateway for this API Management service.
properties.notificationSenderEmail	string		Email address from which the notification will be sent.
properties.outboundPublicIPAddresses	string[]		Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
properties.platformVersion	PlatformVersion		Compute Platform Version running the service in this location.
properties.portalUrl	string		Publisher portal endpoint Url of the API Management service.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		List of Private Endpoint Connections of this service.
properties.privateIPAddresses	string[]		Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
properties.provisioningState	string		The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
properties.publicIpAddressId	string		Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
properties.publisherEmail	string		Publisher email.
properties.publisherName	string		Publisher name.
properties.restore	boolean	False	Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
properties.scmUrl	string		SCM endpoint URL of the API Management service.
properties.targetProvisioningState	string		The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Virtual network configuration of the API Management service.
properties.virtualNetworkType	VirtualNetworkType	None	The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
sku	ApiManagementServiceSkuProperties		SKU properties of the API Management service.
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.
zones	string[]		A list of availability zones denoting where the resource needs to come from.

ApiManagementServiceSkuProperties

API Management service resource SKU properties.

Name	Type	Description
capacity	integer	Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.
name	SkuType	Name of the Sku.

ApimIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Control Plane Apis version constraint for the API Management service.

Name	Type	Description
minApiVersion	string	Limit control plane API calls to API Management service with version equal to or newer than this value.

ArmIdWrapper

A wrapper for an ARM resource id

Name	Type	Description
id	string

CertificateConfiguration

Certificate configuration which consist of non-trusted intermediates and root certificates.

Name	Type	Description
certificate	CertificateInformation	Certificate information.
certificatePassword	string	Certificate Password.
encodedCertificate	string	Base64 Encoded certificate.
storeName	enum: CertificateAuthority Root	The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

CertificateInformation

SSL certificate information.

Name	Type	Description
expiry	string	Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
subject	string	Subject of the certificate.
thumbprint	string	Thumbprint of the certificate.

CertificateSource

Certificate Source.

Name	Type	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Certificate Status.

Name	Type	Description
Completed	string
Failed	string
InProgress	string

ConfigurationApi

Information regarding the Configuration API of the API Management service.

Name	Type	Default value	Description
legacyApi	LegacyApiState	Enabled	Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

developerPortalStatus

Status of developer portal in this API Management service.

Name	Type	Description
Disabled	string	Developer Portal is disabled for the service.
Enabled	string	Developer Portal is enabled for the service.

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.

HostnameConfiguration

Custom hostname configuration.

Name	Type	Default value	Description
certificate	CertificateInformation		Certificate information.
certificatePassword	string		Certificate Password.
certificateSource	CertificateSource		Certificate Source.
certificateStatus	CertificateStatus		Certificate Status.
defaultSslBinding	boolean	False	Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
encodedCertificate	string		Base64 Encoded certificate.
hostName	string		Hostname to configure on the Api Management service.
identityClientId	string		System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
keyVaultId	string		Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
negotiateClientCertificate	boolean	False	Specify true to always negotiate client certificate on the hostname. Default Value is false.
type	HostnameType		Hostname type.

HostnameType

Hostname type.

Name	Type	Description
ConfigurationApi	string
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

LegacyApiState

Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'

Name	Type	Description
Disabled	string	Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it.
Enabled	string	Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it.

LegacyPortalStatus

Status of legacy portal in the API Management service.

Name	Type	Description
Disabled	string	Legacy Portal is disabled for the service.
Enabled	string	Legacy Portal is enabled for the service.

NatGatewayState

Property can be used to enable NAT Gateway for this API Management service.

Name	Type	Description
Disabled	string	Nat Gateway is disabled for the service.
Enabled	string	Nat Gateway is enabled for the service.

PlatformVersion

Compute Platform Version running the service.

Name	Type	Description
mtv1	string	Platform running the service on Multi Tenant V1 platform.
stv1	string	Platform running the service on Single Tenant V1 platform.
stv2	string	Platform running the service on Single Tenant V2 platform.
stv2.1	string	Platform running the service on Single Tenant V2 platform on newer Hardware.
undetermined	string	Platform version cannot be determined, as compute platform is not deployed.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

PublicNetworkAccess

Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'

Name	Type	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Remote Private Endpoint Connection resource.

Name	Type	Description
id	string	Private Endpoint connection resource id
name	string	Private Endpoint Connection Name
properties.groupIds	string[]	All the Group ids.
properties.privateEndpoint	ArmIdWrapper	The resource of private end point.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	string	The provisioning state of the private endpoint connection resource.
type	string	Private Endpoint Connection Resource Type

SkuType

Name of the Sku.

Name	Type	Description
Basic	string	Basic SKU of Api Management.
BasicV2	string	BasicV2 SKU of Api Management.
Consumption	string	Consumption SKU of Api Management.
Developer	string	Developer SKU of Api Management.
Isolated	string	Isolated SKU of Api Management.
Premium	string	Premium SKU of Api Management.
Standard	string	Standard SKU of Api Management.
StandardV2	string	StandardV2 SKU of Api Management.

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.

UserIdentityProperties

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.

VirtualNetworkConfiguration

Configuration of a virtual network to which API Management service is deployed.

Name	Type	Description
subnetResourceId	string	The full resource ID of a subnet in a virtual network to deploy the API Management service in.
subnetname	string	The name of the subnet.
vnetid	string	The virtual network ID. This is typically a GUID. Expect a null GUID by default.

VirtualNetworkType

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

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

Share via

Api Management Service - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ApiManagementServiceGetMultiRegionInternalVnet

Sample request

Sample response

ApiManagementServiceGetService

Sample request

Sample response

ApiManagementServiceGetServiceHavingMsi

Sample request

Sample response

Definitions

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Additional resources