Api Management Service Api

This table represents the api_management_service_api resource from Microsoft Azure.

azure.api_management_service_api

Fields

TitleIDTypeData TypeDescription
_keycorestring
api_revisioncorestringDescribes the revision of the API. If no value is provided, default revision 1 is created
api_revision_descriptioncorestringDescription of the API Revision.
api_versioncorestringIndicates the version identifier of the API if the API is versioned
api_version_descriptioncorestringDescription of the API Version.
api_version_setcorejsonVersion set details
api_version_set_idcorestringA resource identifier for the related ApiVersionSet.
authentication_settingscorejsonCollection of authentication settings included into this API.
contactcorejsonContact information for the API.
descriptioncorestringDescription of the API. May include HTML formatting tags.
idcorestringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
is_currentcoreboolIndicates if API revision is current api revision.
is_onlinecoreboolIndicates if API revision is accessible via the gateway.
licensecorejsonLicense information for the API.
namecorestringThe name of the resource
pathcorestringRelative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocolscorearray<string>Describes on which protocols the operations in this API can be invoked.
provisioning_statecorestringThe provisioning state
resource_groupcorestring
service_urlcorestringAbsolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
source_api_idcorestringAPI identifier of the source API.
subscription_idcorestring
subscription_key_parameter_namescorejsonProtocols over which API is made available.
subscription_namecorestring
subscription_requiredcoreboolSpecifies whether an API or Product subscription is required for accessing the API.
tagscorehstore
terms_of_service_urlcorestringA URL to the Terms of Service for the API. MUST be in the format of a URL.
typecorestringType of API.