Api Management Service

This table represents the api_management_service resource from Microsoft Azure.

azure.api_management_service

Fields

TitleIDTypeData TypeDescription
_keycorestring
additional_locationscorejsonAdditional datacenter locations of the API Management service.
api_version_constraintcorejsonControl Plane Apis version constraint for the API Management service.
certificatescorejsonList of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
configuration_apicorejsonConfiguration API configuration of the API Management service.
created_at_utccorestringCreation 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.
developer_portal_statuscorestringStatus of developer portal in this API Management service.
developer_portal_urlcorestringDEveloper Portal endpoint URL of the API Management service.
disable_gatewaycoreboolProperty only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
enable_client_certificatecoreboolProperty 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.
etagcorestringETag of the resource.
gateway_regional_urlcorestringGateway URL of the API Management service in the Default Region.
gateway_urlcorestringGateway URL of the API Management service.
hostname_configurationscorejsonCustom hostname configuration of the API Management service.
idcorestringResource ID.
identitycorejsonManaged service identity of the Api Management service.
legacy_portal_statuscorestringStatus of legacy portal in the API Management service.
locationcorestringResource location.
management_api_urlcorestringManagement API endpoint URL of the API Management service.
namecorestringResource name.
nat_gateway_statecorestringProperty can be used to enable NAT Gateway for this API Management service.
notification_sender_emailcorestringEmail address from which the notification will be sent.
outbound_public_ip_addressescorearray<string>Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
platform_versioncorestringCompute Platform Version running the service in this location.
portal_urlcorestringPublisher portal endpoint Url of the API Management service.
private_endpoint_connectionscorejsonList of Private Endpoint Connections of this service.
private_ip_addressescorearray<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.
provisioning_statecorestringThe current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
public_ip_address_idcorestringPublic 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.
public_ip_addressescorearray<string>Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
public_network_accesscorestringWhether 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'
publisher_emailcorestringPublisher email.
publisher_namecorestringPublisher name.
resource_groupcorestring
restorecoreboolUndelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
scm_urlcorestringSCM endpoint URL of the API Management service.
skucorejsonSKU properties of the API Management service.
subscription_idcorestring
subscription_namecorestring
system_datacorejsonMetadata pertaining to creation and last modification of the resource.
tagscorehstore
target_provisioning_statecorestringThe provisioning state of the API Management service, which is targeted by the long running operation started on the service.
typecorestringResource type for API Management resource is set to Microsoft.ApiManagement.
virtual_network_configurationcorejsonVirtual network configuration of the API Management service.
virtual_network_typecorestringThe 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.
zonescorearray<string>A list of availability zones denoting where the resource needs to come from.