Data Source: azurermApiManagementApiVersionSet
Uses this data source to access information about an API Version Set within an API Management Service.
Example Usage
import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermApiManagementApiVersionSetExample =
new azurerm.dataAzurermApiManagementApiVersionSet.DataAzurermApiManagementApiVersionSet(
this,
"example",
{
api_management_name: "example-api",
name: "example-api-version-set",
resource_group_name: "example-resources",
}
);
new cdktf.TerraformOutput(this, "api_management_api_version_set_id", {
value: dataAzurermApiManagementApiVersionSetExample.id,
});
Argument Reference
-
name
- The name of the API Version Set. -
resourceGroupName
- The name of the Resource Group in which the parent API Management Service exists. -
apiManagementName
- The name of the API Management Service where the API Version Set exists.
Attributes Reference
-
id
- The ID of the API Version Set. -
description
- The description of API Version Set. -
displayName
- The display name of this API Version Set. -
versioningSchema
- The value that determines where the API Version identifier will be located in a HTTP request. -
versionHeaderName
- The name of the Header which should be read from Inbound Requests which defines the API Version. -
versionQueryName
- The name of the Query String which should be read from Inbound Requests which defines the API Version.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
read
- (Defaults to 5 minutes) Used when retrieving the API Version Set.