@microsoft/terraform-cdk-constructs 0.0.3-pre.6 → 0.0.3-pre.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +909 -306
- package/API.md +2488 -255
- package/README.md +112 -18
- package/docs/images/ide-documentation.png +0 -0
- package/lib/azure-actiongroup/lib/actiongroup.d.ts +39 -0
- package/lib/azure-actiongroup/lib/actiongroup.js +40 -1
- package/lib/azure-applicationgateway/lib/gateway.d.ts +76 -0
- package/lib/azure-applicationgateway/lib/gateway.js +78 -2
- package/lib/azure-applicationinsights/lib/appinsights.d.ts +50 -0
- package/lib/azure-applicationinsights/lib/appinsights.js +52 -3
- package/lib/azure-containerregistry/lib/registry.d.ts +29 -0
- package/lib/azure-containerregistry/lib/registry.js +31 -2
- package/lib/azure-datalake/lib/datalake.d.ts +50 -0
- package/lib/azure-datalake/lib/datalake.js +51 -1
- package/lib/azure-datalake/lib/filesystem.d.ts +51 -0
- package/lib/azure-datalake/lib/filesystem.js +52 -1
- package/lib/azure-datalake/lib/path.d.ts +37 -0
- package/lib/azure-datalake/lib/path.js +38 -1
- package/lib/azure-eventhub/lib/authorization.d.ts +30 -0
- package/lib/azure-eventhub/lib/authorization.js +32 -2
- package/lib/azure-eventhub/lib/cluster.d.ts +29 -0
- package/lib/azure-eventhub/lib/cluster.js +31 -2
- package/lib/azure-eventhub/lib/consumer.d.ts +28 -0
- package/lib/azure-eventhub/lib/consumer.js +30 -2
- package/lib/azure-eventhub/lib/instance.d.ts +118 -0
- package/lib/azure-eventhub/lib/instance.js +120 -2
- package/lib/azure-eventhub/lib/kusto-connection.d.ts +41 -0
- package/lib/azure-eventhub/lib/kusto-connection.js +43 -2
- package/lib/azure-eventhub/lib/namespace.d.ts +74 -0
- package/lib/azure-eventhub/lib/namespace.js +76 -3
- package/lib/azure-functionapp/lib/functionapplinux.js +1 -1
- package/lib/azure-keyvault/lib/certificate.d.ts +96 -2
- package/lib/azure-keyvault/lib/certificate.js +55 -3
- package/lib/azure-keyvault/lib/key.d.ts +36 -0
- package/lib/azure-keyvault/lib/key.js +38 -2
- package/lib/azure-keyvault/lib/policy.d.ts +30 -0
- package/lib/azure-keyvault/lib/policy.js +32 -2
- package/lib/azure-keyvault/lib/secret.d.ts +31 -0
- package/lib/azure-keyvault/lib/secret.js +33 -2
- package/lib/azure-keyvault/lib/vault.d.ts +188 -0
- package/lib/azure-keyvault/lib/vault.js +191 -7
- package/lib/azure-kubernetes/lib/cluster.d.ts +25 -4
- package/lib/azure-kubernetes/lib/cluster.js +27 -6
- package/lib/azure-kusto/lib/cluster.d.ts +53 -0
- package/lib/azure-kusto/lib/cluster.js +55 -2
- package/lib/azure-kusto/lib/compute-specification.js +1 -1
- package/lib/azure-kusto/lib/database.d.ts +103 -0
- package/lib/azure-kusto/lib/database.js +105 -2
- package/lib/azure-loganalytics/lib/workspace.d.ts +47 -0
- package/lib/azure-loganalytics/lib/workspace.js +49 -2
- package/lib/azure-metricalert/lib/metric-alert.d.ts +43 -4
- package/lib/azure-metricalert/lib/metric-alert.js +45 -6
- package/lib/azure-networksecuritygroup/lib/preconfigured-rules.js +1 -1
- package/lib/azure-networksecuritygroup/lib/securitygroup.d.ts +92 -0
- package/lib/azure-networksecuritygroup/lib/securitygroup.js +95 -5
- package/lib/azure-queryrulealert/lib/query-rule-alert.d.ts +35 -4
- package/lib/azure-queryrulealert/lib/query-rule-alert.js +37 -6
- package/lib/azure-resourcegroup/lib/resource-group.d.ts +28 -0
- package/lib/azure-resourcegroup/lib/resource-group.js +30 -2
- package/lib/azure-storageaccount/lib/account.d.ts +75 -48
- package/lib/azure-storageaccount/lib/account.js +77 -50
- package/lib/azure-storageaccount/lib/container.d.ts +94 -12
- package/lib/azure-storageaccount/lib/container.js +97 -15
- package/lib/azure-storageaccount/lib/fileshare.d.ts +36 -0
- package/lib/azure-storageaccount/lib/fileshare.js +39 -3
- package/lib/azure-storageaccount/lib/queue.d.ts +29 -0
- package/lib/azure-storageaccount/lib/queue.js +31 -2
- package/lib/azure-storageaccount/lib/table.d.ts +32 -0
- package/lib/azure-storageaccount/lib/table.js +34 -2
- package/lib/azure-virtualmachine/lib/image-references.js +2 -2
- package/lib/azure-virtualmachine/lib/vm.d.ts +84 -8
- package/lib/azure-virtualmachine/lib/vm.js +87 -11
- package/lib/azure-virtualmachinescaleset/lib/cluster.d.ts +98 -8
- package/lib/azure-virtualmachinescaleset/lib/cluster.js +101 -11
- package/lib/azure-virtualnetwork/lib/network.d.ts +61 -0
- package/lib/azure-virtualnetwork/lib/network.js +63 -3
- package/lib/azure-virtualnetwork/lib/peering.d.ts +39 -0
- package/lib/azure-virtualnetwork/lib/peering.js +41 -2
- package/lib/core-azure/lib/diagsettings.d.ts +37 -0
- package/lib/core-azure/lib/diagsettings.js +39 -2
- package/lib/core-azure/lib/rbac.d.ts +22 -4
- package/lib/core-azure/lib/rbac.js +24 -6
- package/lib/core-azure/lib/resource.d.ts +45 -0
- package/lib/core-azure/lib/resource.js +48 -4
- package/package.json +1 -1
package/.jsii
CHANGED
|
@@ -1470,7 +1470,7 @@
|
|
|
1470
1470
|
},
|
|
1471
1471
|
"name": "@microsoft/terraform-cdk-constructs",
|
|
1472
1472
|
"readme": {
|
|
1473
|
-
"markdown": "# Terraform
|
|
1473
|
+
"markdown": "# Azure Terraform CDK Constructs\nWelcome to the Azure Terraform CDK Constructs project! This library offers a comprehensive suite of L2 Constructs designed to simplify and enhance the experience of building and managing Azure infrastructure with the Cloud Development Kit for Terraform (CDKTF).\n\n## Benefits of Using L2 Constructs\n\nWith L2 Constructs, you get the following benefits:\n\n- **Abstraction**: Higher-level abstractions over Azure resources make your infrastructure code more declarative and easier to understand.\n- **Reusability**: Encapsulate common patterns and best practices in your infrastructure code, promoting reusability across different projects and teams.\n- **Rapid Development**: Accelerate your cloud development process with pre-built constructs that have been tested for common use cases, allowing you to focus on your unique application logic.\n- **Direct IDE Integration**: Access detailed documentation directly within your Integrated Development Environment (IDE), streamlining your development workflow: \n\n\n## Quick Example\n\nThis is a quick example that showcases the simplicity and power of L2 Constructs. We'll create a storage account, add a container to it, and then upload a blob—all with a few lines of intuitive, object-oriented code:\n\n```typescript\n\n// Create a new instance of a storage account as an object\nconst sa = new azcdk.azure_storageaccount.Account(stack, \"storageaccount\", {\n name: \"testStorageAccount\",\n location: \"eastus\",\n});\n\n// Add a container to the storage account by calling a method on the storage account object\nconst container = sa.addContainer(\"testcontainer\");\n\n// Add a blob to the container by calling a method on the container object\n// The path \"../../../test.txt\" points to the source file to be uploaded as a blob\ncontainer.addBlob(\"testblob.txt\", \"../../../test.txt\");\n```\n\n\n\n## Getting Started\n\nThis guide will walk you through the process of using the Azure L2 Constructs to define and provision infrastructure on Azure.\n\n### Prerequisites\nMake sure you have Node.js and npm installed on your machine. These will be used to install the CDK for Terraform and Azure provider packages.\n\n### Installation\n\nFirst, install the CDK for Terraform CLI globally using npm:\n\n```sh\nnpm install -g cdktf-cli\n```\n\nNext, initialize a new CDK for Terraform project with TypeScript template:\n```sh\ncdktf init --template=\"TypeScript\" --local\n```\nInstall the AzureRM provider for CDKTF:\n\n```sh\nnpm install @cdktf/provider-azurerm\n```\n\nThen, add the Microsoft Terraform CDK constructs for Azure:\n\n```sh\nnpm install @micrsoft/terraform-cdk-constructs\n\n```\n\n\n### Example 1: Creating a Storage Account\nNow let's create a simple Azure storage account. The following TypeScript snippet defines a storage account resource using the CDKTF:\n\n```typescript\n// Import necessary modules and classes\nimport * as azcdk from \"@microsoft/terraform-cdk-constructs\";\nimport { Construct } from 'constructs';\nimport { App, TerraformStack } from 'cdktf';\nimport { AzurermProvider } from \"@cdktf/provider-azurerm/lib/provider\";\n\n// Define a new Terraform stack\nclass AzureAppInfra extends TerraformStack {\n constructor(scope: Construct, name: string) {\n super(scope, name);\n\n // Initialize Azure provider\n new AzurermProvider(this, \"azureFeature\", { features: {} });\n\n // Create a new Azure storage account with the specified name and location\n new azcdk.azure_storageaccount.Account(this, \"storageaccount\", {\n name: \"test42348808\",\n location: \"eastus\",\n });\n }\n}\n\n// Initialize the CDK app and synthesize Terraform configurations\nconst app = new App();\nnew AzureAppInfra(app, 'cdk');\napp.synth();\n```\nAfter defining your infrastructure, generate the Terraform configuration files:\n```sh\ncdktf synth\n```\nFinally, deploy your infrastructure to Azure:\n\n```sh\ncdktf deploy\n```\n## Supported Languages\n\nCurrently, our CDK L2 constructs are available in the following languages:\n\n| Language | Status |\n|------------|--------------|\n| TypeScript | Available |\n| Python | Coming soon |\n| Java | Coming soon |\n| Go | Coming soon |\n| C# | Coming soon |\n\nStay tuned for updates as we work to expand support to other popular programming languages!\n\n\n## Contributing\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.\n\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\nWe welcome contributions to this project! See our documentation on [how to get started contributing](./docs/CONTRIBUTING.md).\n\n## Code Spaces\n\nTo open this repository in a Code Space, click the button below:\n\n[](https://github.com/microsoft/terraform-azure-cdk-modules/codespaces)\n\n## Trademarks\n\nThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft\ntrademarks or logos is subject to and must follow\n[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).\nUse of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.\nAny use of third-party trademarks or logos are subject to those third-party's policies.\n"
|
|
1474
1474
|
},
|
|
1475
1475
|
"repository": {
|
|
1476
1476
|
"type": "git",
|
|
@@ -1671,26 +1671,37 @@
|
|
|
1671
1671
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_applicationgateway.Gateway",
|
|
1672
1672
|
"initializer": {
|
|
1673
1673
|
"docs": {
|
|
1674
|
-
"stability": "stable"
|
|
1674
|
+
"stability": "stable",
|
|
1675
|
+
"summary": "Constructs a new Azure Application Gateway."
|
|
1675
1676
|
},
|
|
1676
1677
|
"locationInModule": {
|
|
1677
1678
|
"filename": "src/azure-applicationgateway/lib/gateway.ts",
|
|
1678
|
-
"line":
|
|
1679
|
+
"line": 293
|
|
1679
1680
|
},
|
|
1680
1681
|
"parameters": [
|
|
1681
1682
|
{
|
|
1683
|
+
"docs": {
|
|
1684
|
+
"summary": "- The scope in which to define this construct."
|
|
1685
|
+
},
|
|
1682
1686
|
"name": "scope",
|
|
1683
1687
|
"type": {
|
|
1684
1688
|
"fqn": "constructs.Construct"
|
|
1685
1689
|
}
|
|
1686
1690
|
},
|
|
1687
1691
|
{
|
|
1692
|
+
"docs": {
|
|
1693
|
+
"summary": "- The ID of this construct."
|
|
1694
|
+
},
|
|
1688
1695
|
"name": "id",
|
|
1689
1696
|
"type": {
|
|
1690
1697
|
"primitive": "string"
|
|
1691
1698
|
}
|
|
1692
1699
|
},
|
|
1693
1700
|
{
|
|
1701
|
+
"docs": {
|
|
1702
|
+
"remarks": "The properties include:\n - `name`: Required. Unique name for the Application Gateway within Azure.\n - `location`: Required. Azure Region for deployment.\n - `resourceGroup`: Required. Reference to the resource group for deployment.\n - `skuTier`: Required. SKU tier of the Application Gateway (e.g., Standard, WAF).\n - `skuSize`: Required. Size of the SKU for the Application Gateway.\n - `capacity`: Required. Capacity (instance count) of the Application Gateway.\n - `backendAddressPools`: Required. Backend address pools for the Application Gateway.\n - `backendHttpSettings`: Required. Backend HTTP settings for the Application Gateway.\n - `httpListeners`: Required. HTTP listeners for the Application Gateway.\n - `requestRoutingRules`: Required. Request routing rules for the Application Gateway.\n - `publicIpAddress`: Optional. Public IP address for the frontend.\n - `privateIpAddress`: Optional. Private IP address for the frontend.\n - `privateIpAddressAllocation`: Optional. Allocation method for the private IP (Static, Dynamic).\n - `frontendPorts`: Optional. Frontend ports for the Application Gateway.\n - `subnet`: Optional. Subnet for the Application Gateway.\n - `enableHttp2`: Optional. Flag to enable HTTP2.\n - `fipsEnabled`: Optional. Flag to enable FIPS-compliant algorithms.\n - `firewallPolicyId`: Optional. ID of the firewall policy.\n - `forceFirewallPolicyAssociation`: Optional. Flag to enforce association of the firewall policy.\n - `tags`: Optional. Tags for resource management.\n - Additional optional properties as described in `IGatewayProps` interface.\n\nExample usage:\n```typescript\nnew Gateway(this, 'appGateway1', {\nname: 'gatewayEast',\nresourceGroup: resourceGroup,\nlocation: \"eastus\",\nskuTier: \"Standard_v2\",\nskuSize: \"Standard_v2\",\ncapacity: 2,\npublicIpAddress: publicIp,\nsubnet: subnet,\nbackendAddressPools: [\n{ name: \"backend-address-pool-1\" },\n{\nname: \"backend-address-pool-2\",\nipAddresses: [\"10.1.0.4\", \"10.1.0.5\", \"10.1.0.6\"],\n},\n],\nhttpListeners: [\n{\nname: \"http-listener\",\nfrontendPortName: \"80\",\nfrontendIpConfigurationName: \"Public-frontend-ip-configuration\",\nprotocol: \"Http\",\n},\n],\nbackendHttpSettings: [\n{\nname: \"backend-http-setting\",\nport: 80,\nprotocol: \"Http\",\nrequestTimeout: 20,\ncookieBasedAffinity: \"Disabled\",\n},\n],\nrequestRoutingRules: [\n{\nname: \"request-routing-rule-1\",\nhttpListenerName: \"http-listener\",\npriority: 1,\nbackendAddressPoolName: \"backend-address-pool-1\",\nbackendHttpSettingsName: \"backend-http-setting\",\nruleType: \"Basic\",\n},\n],\n});\n```",
|
|
1703
|
+
"summary": "- The properties for configuring the Azure Application Gateway."
|
|
1704
|
+
},
|
|
1694
1705
|
"name": "props",
|
|
1695
1706
|
"type": {
|
|
1696
1707
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_applicationgateway.IGatewayProps"
|
|
@@ -2503,26 +2514,37 @@
|
|
|
2503
2514
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_applicationinsights.AppInsights",
|
|
2504
2515
|
"initializer": {
|
|
2505
2516
|
"docs": {
|
|
2506
|
-
"stability": "stable"
|
|
2517
|
+
"stability": "stable",
|
|
2518
|
+
"summary": "Constructs a new Azure Application Insights resource."
|
|
2507
2519
|
},
|
|
2508
2520
|
"locationInModule": {
|
|
2509
2521
|
"filename": "src/azure-applicationinsights/lib/appinsights.ts",
|
|
2510
|
-
"line":
|
|
2522
|
+
"line": 98
|
|
2511
2523
|
},
|
|
2512
2524
|
"parameters": [
|
|
2513
2525
|
{
|
|
2526
|
+
"docs": {
|
|
2527
|
+
"summary": "- The scope in which to define this construct."
|
|
2528
|
+
},
|
|
2514
2529
|
"name": "scope",
|
|
2515
2530
|
"type": {
|
|
2516
2531
|
"fqn": "constructs.Construct"
|
|
2517
2532
|
}
|
|
2518
2533
|
},
|
|
2519
2534
|
{
|
|
2535
|
+
"docs": {
|
|
2536
|
+
"summary": "- The ID of this construct."
|
|
2537
|
+
},
|
|
2520
2538
|
"name": "id",
|
|
2521
2539
|
"type": {
|
|
2522
2540
|
"primitive": "string"
|
|
2523
2541
|
}
|
|
2524
2542
|
},
|
|
2525
2543
|
{
|
|
2544
|
+
"docs": {
|
|
2545
|
+
"remarks": "The properties include:\n - `name`: Required. Unique name for the Application Insights resource within Azure.\n - `location`: Required. Azure Region for deployment.\n - `resourceGroup`: Required. Reference to the Azure Resource Group for deployment.\n - `retentionInDays`: Optional. Number of days to retain data. Default is 90 days.\n - `tags`: Optional. Tags for resource management.\n - `applicationType`: Required. The type of application (e.g., web, other).\n - `dailyDataCapInGb`: Optional. Daily data cap in gigabytes.\n - `dailyDataCapNotificationDisabled`: Optional. Flag to disable notifications when the daily data cap is reached.\n - `workspaceId`: Optional. ID of the Log Analytics Workspace to associate with Application Insights. If not provided, a new workspace is created automatically.\n\nExample usage:\n```typescript\nnew AppInsights(this, 'myAppInsights', {\nname: 'myAppInsightsResource',\nlocation: 'West US',\nresourceGroup: resourceGroup,\nretentionInDays: 120,\ntags: {\n\"environment\": \"production\"\n},\napplicationType: 'web',\ndailyDataCapInGb: 10,\ndailyDataCapNotificationDisabled: true,\nworkspaceId: 'existing-workspace-id'\n});\n```",
|
|
2546
|
+
"summary": "- The properties for configuring the Azure Application Insights."
|
|
2547
|
+
},
|
|
2526
2548
|
"name": "props",
|
|
2527
2549
|
"type": {
|
|
2528
2550
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_applicationinsights.AppInsightsProps"
|
|
@@ -2538,21 +2560,30 @@
|
|
|
2538
2560
|
"methods": [
|
|
2539
2561
|
{
|
|
2540
2562
|
"docs": {
|
|
2541
|
-
"
|
|
2563
|
+
"remarks": "This method creates a new secret in the specified Azure Key Vault with the\ninstrumentation key of the Application Insights resource. This enables secure storage\nand management of the instrumentation key, facilitating secure access across various\nAzure services.",
|
|
2564
|
+
"stability": "stable",
|
|
2565
|
+
"summary": "Saves the Application Insights instrumentation key to an Azure Key Vault."
|
|
2542
2566
|
},
|
|
2543
2567
|
"locationInModule": {
|
|
2544
2568
|
"filename": "src/azure-applicationinsights/lib/appinsights.ts",
|
|
2545
|
-
"line":
|
|
2569
|
+
"line": 185
|
|
2546
2570
|
},
|
|
2547
2571
|
"name": "saveIKeyToKeyVault",
|
|
2548
2572
|
"parameters": [
|
|
2549
2573
|
{
|
|
2574
|
+
"docs": {
|
|
2575
|
+
"summary": "- The unique identifier of the Azure Key Vault where the secret will be stored."
|
|
2576
|
+
},
|
|
2550
2577
|
"name": "keyVaultId",
|
|
2551
2578
|
"type": {
|
|
2552
2579
|
"primitive": "string"
|
|
2553
2580
|
}
|
|
2554
2581
|
},
|
|
2555
2582
|
{
|
|
2583
|
+
"docs": {
|
|
2584
|
+
"remarks": "Defaults to 'instrumentation-key'.\n This name can be used to retrieve the secret in client applications.\n\nExample usage:\n```typescript\nappInsightsInstance.saveIKeyToKeyVault('my-key-vault-id');\n```",
|
|
2585
|
+
"summary": "- The name of the secret within the Key Vault."
|
|
2586
|
+
},
|
|
2556
2587
|
"name": "keyVaultSecretName",
|
|
2557
2588
|
"optional": true,
|
|
2558
2589
|
"type": {
|
|
@@ -2795,26 +2826,38 @@
|
|
|
2795
2826
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_containerregistry.Registry",
|
|
2796
2827
|
"initializer": {
|
|
2797
2828
|
"docs": {
|
|
2798
|
-
"
|
|
2829
|
+
"remarks": "This class creates an Azure Container Registry instance, which is a managed Docker registry service based on the Docker Registry 2.0 specification.\nThis service enables you to store and manage container images across all types of Azure deployments, you can also use it to build, store, and manage images for all types of container deployments.",
|
|
2830
|
+
"stability": "stable",
|
|
2831
|
+
"summary": "Constructs a new Azure Container Registry (ACR)."
|
|
2799
2832
|
},
|
|
2800
2833
|
"locationInModule": {
|
|
2801
2834
|
"filename": "src/azure-containerregistry/lib/registry.ts",
|
|
2802
|
-
"line":
|
|
2835
|
+
"line": 72
|
|
2803
2836
|
},
|
|
2804
2837
|
"parameters": [
|
|
2805
2838
|
{
|
|
2839
|
+
"docs": {
|
|
2840
|
+
"summary": "- The scope in which to define this construct, typically used for managing lifecycles and creation order."
|
|
2841
|
+
},
|
|
2806
2842
|
"name": "scope",
|
|
2807
2843
|
"type": {
|
|
2808
2844
|
"fqn": "constructs.Construct"
|
|
2809
2845
|
}
|
|
2810
2846
|
},
|
|
2811
2847
|
{
|
|
2848
|
+
"docs": {
|
|
2849
|
+
"summary": "- The unique identifier for this construct instance."
|
|
2850
|
+
},
|
|
2812
2851
|
"name": "id",
|
|
2813
2852
|
"type": {
|
|
2814
2853
|
"primitive": "string"
|
|
2815
2854
|
}
|
|
2816
2855
|
},
|
|
2817
2856
|
{
|
|
2857
|
+
"docs": {
|
|
2858
|
+
"remarks": "The properties include:\n - `location`: Required. The Azure region where the registry will be deployed.\n - `name`: Required. The name of the Container Registry.\n - `resourceGroup`: Required. The Azure Resource Group in which to deploy the registry.\n - `sku`: Optional. The SKU of the Container Registry (e.g., Basic, Standard, Premium). Determines the features available.\n - `tags`: Optional. Tags for resource management.\n - `adminEnabled`: Optional. Specifies whether the admin user is enabled for the registry. Defaults to false if not set.\n - `geoReplicationLocations`: Optional. Specifies additional Azure regions where the registry should be geo-replicated.\n\nExample usage:\n```typescript\nnew Registry(this, 'myRegistry', {\nlocation: 'West US',\nname: 'myContainerRegistry',\nresourceGroup: resourceGroup,\nsku: 'Premium',\nadminEnabled: true,\ngeoReplicationLocations: ['East US', 'West Europe']\n});\n```",
|
|
2859
|
+
"summary": "- The properties for configuring the Azure Container Registry."
|
|
2860
|
+
},
|
|
2818
2861
|
"name": "props",
|
|
2819
2862
|
"type": {
|
|
2820
2863
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_containerregistry.RegistryProps"
|
|
@@ -3023,26 +3066,41 @@
|
|
|
3023
3066
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.AuthorizationRule",
|
|
3024
3067
|
"initializer": {
|
|
3025
3068
|
"docs": {
|
|
3026
|
-
"
|
|
3069
|
+
"custom": {
|
|
3070
|
+
"remarks": "The primary connection string and primary key are accessible after the instance creation,\nallowing for integration with other Azure services or client applications."
|
|
3071
|
+
},
|
|
3072
|
+
"remarks": "This class creates an authorization rule which defines the permissions granted to users and applications\nfor accessing and managing the Event Hub. An Authorization Rule can grant listening, sending, and full manage\npermissions based on the properties specified.",
|
|
3073
|
+
"stability": "stable",
|
|
3074
|
+
"summary": "Constructs a new Authorization Rule for an Azure Event Hub."
|
|
3027
3075
|
},
|
|
3028
3076
|
"locationInModule": {
|
|
3029
3077
|
"filename": "src/azure-eventhub/lib/authorization.ts",
|
|
3030
|
-
"line":
|
|
3078
|
+
"line": 62
|
|
3031
3079
|
},
|
|
3032
3080
|
"parameters": [
|
|
3033
3081
|
{
|
|
3082
|
+
"docs": {
|
|
3083
|
+
"summary": "- The scope in which to define this construct, typically used for managing lifecycles and creation order."
|
|
3084
|
+
},
|
|
3034
3085
|
"name": "scope",
|
|
3035
3086
|
"type": {
|
|
3036
3087
|
"fqn": "constructs.Construct"
|
|
3037
3088
|
}
|
|
3038
3089
|
},
|
|
3039
3090
|
{
|
|
3091
|
+
"docs": {
|
|
3092
|
+
"summary": "- The unique name for this instance of the Authorization Rule."
|
|
3093
|
+
},
|
|
3040
3094
|
"name": "name",
|
|
3041
3095
|
"type": {
|
|
3042
3096
|
"primitive": "string"
|
|
3043
3097
|
}
|
|
3044
3098
|
},
|
|
3045
3099
|
{
|
|
3100
|
+
"docs": {
|
|
3101
|
+
"remarks": "The properties include:\n- `name`: Required. The name of the Authorization Rule.\n- `listen`: Optional. Specifies whether the rule allows listening to the Event Hub. Defaults to false.\n- `send`: Optional. Specifies whether the rule allows sending events to the Event Hub. Defaults to false.\n- `manage`: Optional. Specifies whether the rule allows managing the Event Hub, including sending and listening. Defaults to false.\nWhen `manage` is true, both `listen` and `send` are implicitly set to true.\n\nExample usage:\n```typescript\nconst authRule = new AuthorizationRule(this, 'exampleAuthRule', {\nname: 'myAuthRule',\nlisten: true,\nsend: true,\nmanage: false // Only listening and sending are enabled; not managing.\n});\n```",
|
|
3102
|
+
"summary": "- The properties for configuring the Authorization Rule."
|
|
3103
|
+
},
|
|
3046
3104
|
"name": "ehInstanceAuthProps",
|
|
3047
3105
|
"type": {
|
|
3048
3106
|
"fqn": "@cdktf/provider-azurerm.eventhubAuthorizationRule.EventhubAuthorizationRuleConfig"
|
|
@@ -3062,7 +3120,7 @@
|
|
|
3062
3120
|
},
|
|
3063
3121
|
"locationInModule": {
|
|
3064
3122
|
"filename": "src/azure-eventhub/lib/authorization.ts",
|
|
3065
|
-
"line":
|
|
3123
|
+
"line": 115
|
|
3066
3124
|
},
|
|
3067
3125
|
"name": "addPrimaryConnectionStringToVault",
|
|
3068
3126
|
"parameters": [
|
|
@@ -3093,7 +3151,7 @@
|
|
|
3093
3151
|
},
|
|
3094
3152
|
"locationInModule": {
|
|
3095
3153
|
"filename": "src/azure-eventhub/lib/authorization.ts",
|
|
3096
|
-
"line":
|
|
3154
|
+
"line": 123
|
|
3097
3155
|
},
|
|
3098
3156
|
"name": "addPrimaryKeyToVault",
|
|
3099
3157
|
"parameters": [
|
|
@@ -3551,26 +3609,38 @@
|
|
|
3551
3609
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.Cluster",
|
|
3552
3610
|
"initializer": {
|
|
3553
3611
|
"docs": {
|
|
3554
|
-
"
|
|
3612
|
+
"remarks": "This class creates an Azure Event Hub Cluster which is a dedicated capacity resource for handling\nhigh-throughput, low-latency event ingestion and streaming. It is used in scenarios where you need\npredictable performance and cost regardless of the volume of data ingress or number of downstream\nevent consumers.",
|
|
3613
|
+
"stability": "stable",
|
|
3614
|
+
"summary": "Constructs a new Event Hub Cluster."
|
|
3555
3615
|
},
|
|
3556
3616
|
"locationInModule": {
|
|
3557
3617
|
"filename": "src/azure-eventhub/lib/cluster.ts",
|
|
3558
|
-
"line":
|
|
3618
|
+
"line": 58
|
|
3559
3619
|
},
|
|
3560
3620
|
"parameters": [
|
|
3561
3621
|
{
|
|
3622
|
+
"docs": {
|
|
3623
|
+
"summary": "- The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack."
|
|
3624
|
+
},
|
|
3562
3625
|
"name": "scope",
|
|
3563
3626
|
"type": {
|
|
3564
3627
|
"fqn": "constructs.Construct"
|
|
3565
3628
|
}
|
|
3566
3629
|
},
|
|
3567
3630
|
{
|
|
3631
|
+
"docs": {
|
|
3632
|
+
"summary": "- The unique name for this instance of the Event Hub Cluster."
|
|
3633
|
+
},
|
|
3568
3634
|
"name": "name",
|
|
3569
3635
|
"type": {
|
|
3570
3636
|
"primitive": "string"
|
|
3571
3637
|
}
|
|
3572
3638
|
},
|
|
3573
3639
|
{
|
|
3640
|
+
"docs": {
|
|
3641
|
+
"remarks": "These properties include:\n- `resourceGroup`: Required. The Azure Resource Group in which the cluster will be deployed.\n- `name`: Required. The name of the Event Hub Cluster.\n- `skuName`: Optional. The SKU name for the cluster, which determines the pricing and capabilities.\n Currently, the only supported value is \"Dedicated_1\". Defaults to \"Dedicated_1\" if not specified.\n- `tags`: Optional. Tags for resource management and categorization.\n\nExample usage:\n```typescript\nconst eventHubCluster = new Cluster(this, 'myEventHubCluster', {\nresourceGroup: resourceGroup,\nname: 'myCluster',\nskuName: 'Dedicated_1', // This is optional since it defaults to 'Dedicated_1'\ntags: {\ndepartment: 'IT'\n}\n});\n```",
|
|
3642
|
+
"summary": "- The properties for configuring the Event Hub Cluster."
|
|
3643
|
+
},
|
|
3574
3644
|
"name": "ehClusterProps",
|
|
3575
3645
|
"type": {
|
|
3576
3646
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.ClusterProps"
|
|
@@ -3730,26 +3800,38 @@
|
|
|
3730
3800
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.ConsumerGroup",
|
|
3731
3801
|
"initializer": {
|
|
3732
3802
|
"docs": {
|
|
3733
|
-
"
|
|
3803
|
+
"remarks": "An Event Hub Consumer Group is a view of an entire Event Hub that enables consumer applications to each have\na separate view of the event stream. They read the stream independently at their own pace and with their own\noffsets. This class creates a consumer group for a specified Event Hub, allowing for decentralized and\nscalable event processing.",
|
|
3804
|
+
"stability": "stable",
|
|
3805
|
+
"summary": "Constructs a new Event Hub Consumer Group."
|
|
3734
3806
|
},
|
|
3735
3807
|
"locationInModule": {
|
|
3736
3808
|
"filename": "src/azure-eventhub/lib/consumer.ts",
|
|
3737
|
-
"line":
|
|
3809
|
+
"line": 58
|
|
3738
3810
|
},
|
|
3739
3811
|
"parameters": [
|
|
3740
3812
|
{
|
|
3813
|
+
"docs": {
|
|
3814
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
3815
|
+
},
|
|
3741
3816
|
"name": "scope",
|
|
3742
3817
|
"type": {
|
|
3743
3818
|
"fqn": "constructs.Construct"
|
|
3744
3819
|
}
|
|
3745
3820
|
},
|
|
3746
3821
|
{
|
|
3822
|
+
"docs": {
|
|
3823
|
+
"summary": "- The unique name for this instance of the Consumer Group."
|
|
3824
|
+
},
|
|
3747
3825
|
"name": "name",
|
|
3748
3826
|
"type": {
|
|
3749
3827
|
"primitive": "string"
|
|
3750
3828
|
}
|
|
3751
3829
|
},
|
|
3752
3830
|
{
|
|
3831
|
+
"docs": {
|
|
3832
|
+
"remarks": "These properties include:\n- `name`: Required. The name of the Consumer Group.\n- `resourceGroup`: Required. The Azure Resource Group in which the Consumer Group's grandparent Namespace exists.\n- `namespaceName`: Required. The name of the grandparent EventHub Namespace.\n- `eventhubName`: Required. The name of the Event Hub for which the consumer group is created.\n- `userMetadata`: Optional. User-defined metadata to provide additional context about the Consumer Group.\n\nExample usage:\n```typescript\nconst consumerGroup = new ConsumerGroup(this, 'myConsumerGroup', {\nresourceGroup: resourceGroup,\nnamespaceName: 'exampleNamespace',\neventhubName: 'exampleEventHub',\nname: 'myConsumerGroupName',\nuserMetadata: 'Information about consumer group'\n});\n```",
|
|
3833
|
+
"summary": "- The properties for configuring the Consumer Group."
|
|
3834
|
+
},
|
|
3753
3835
|
"name": "ehConsumerGroupProps",
|
|
3754
3836
|
"type": {
|
|
3755
3837
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.ConsumerGroupProps"
|
|
@@ -3903,26 +3985,38 @@
|
|
|
3903
3985
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.Instance",
|
|
3904
3986
|
"initializer": {
|
|
3905
3987
|
"docs": {
|
|
3906
|
-
"
|
|
3988
|
+
"remarks": "This class creates an Azure Event Hub instance within a specified namespace. Event Hubs is a highly scalable\ndata streaming platform and event ingestion service, capable of receiving and processing millions of events per second.\nEvent Hubs can process and store events, data, or telemetry produced by distributed software and devices.",
|
|
3989
|
+
"stability": "stable",
|
|
3990
|
+
"summary": "Constructs a new Event Hub instance."
|
|
3907
3991
|
},
|
|
3908
3992
|
"locationInModule": {
|
|
3909
3993
|
"filename": "src/azure-eventhub/lib/instance.ts",
|
|
3910
|
-
"line":
|
|
3994
|
+
"line": 85
|
|
3911
3995
|
},
|
|
3912
3996
|
"parameters": [
|
|
3913
3997
|
{
|
|
3998
|
+
"docs": {
|
|
3999
|
+
"summary": "- The scope in which to define this construct, typically used for managing lifecycles and creation order."
|
|
4000
|
+
},
|
|
3914
4001
|
"name": "scope",
|
|
3915
4002
|
"type": {
|
|
3916
4003
|
"fqn": "constructs.Construct"
|
|
3917
4004
|
}
|
|
3918
4005
|
},
|
|
3919
4006
|
{
|
|
4007
|
+
"docs": {
|
|
4008
|
+
"summary": "- The unique name for this instance of the Event Hub."
|
|
4009
|
+
},
|
|
3920
4010
|
"name": "name",
|
|
3921
4011
|
"type": {
|
|
3922
4012
|
"primitive": "string"
|
|
3923
4013
|
}
|
|
3924
4014
|
},
|
|
3925
4015
|
{
|
|
4016
|
+
"docs": {
|
|
4017
|
+
"remarks": "The properties include:\n- `name`: Required. The name of the Event Hub instance.\n- `partitionCount`: Optional. The number of partitions for the Event Hub. Defaults to 2. Max value is 32 for shared namespaces.\n- `messageRetention`: Optional. The number of days to retain the messages. Defaults to 1.\n- `status`: Optional. Specifies the operational status of the Event Hub (Active, Disabled, SendDisabled). Defaults to \"Active\".\n- `resourceGroup`: Required. The name of the resource group in which the Event Hub's parent namespace exists.\n- `namespaceName`: Required. The name of the Event Hub Namespace where this instance will be created.\n\nExample usage:\n```typescript\nconst eventHubInstance = new Instance(this, 'myEventHubInstance', {\nname: 'exampleEventHub',\nnamespaceName: 'exampleNamespace',\nresourceGroup: resourceGroup,\npartitionCount: 4,\nmessageRetention: 7,\nstatus: 'Active'\n});\n```",
|
|
4018
|
+
"summary": "- The properties for configuring the Event Hub instance."
|
|
4019
|
+
},
|
|
3926
4020
|
"name": "ehInstanceProps",
|
|
3927
4021
|
"type": {
|
|
3928
4022
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.InstanceProps"
|
|
@@ -3938,15 +4032,22 @@
|
|
|
3938
4032
|
"methods": [
|
|
3939
4033
|
{
|
|
3940
4034
|
"docs": {
|
|
3941
|
-
"
|
|
4035
|
+
"remarks": "This method creates a new Authorization Rule associated with the specified Event Hub,\ngranting specified permissions such as 'listen', 'send', and 'manage' based on the properties provided.\nThe rule determines the access level granted to users and applications for the Event Hub.",
|
|
4036
|
+
"returns": "An instance of the AuthorizationRule class, configured with the specified permissions and associated\nwith the Event Hub specified in the enclosing construct's properties.\n\nExample usage:\n```typescript\nconst eventHubAuthRule = eventHubInstance.addAuthorizationRule({\nname: 'myCustomAuthRule',\nlisten: true,\nsend: true,\nmanage: false // Only listening and sending permissions are granted.\n});\n```",
|
|
4037
|
+
"stability": "stable",
|
|
4038
|
+
"summary": "Adds an Authorization Rule to an Event Hub instance."
|
|
3942
4039
|
},
|
|
3943
4040
|
"locationInModule": {
|
|
3944
4041
|
"filename": "src/azure-eventhub/lib/instance.ts",
|
|
3945
|
-
"line":
|
|
4042
|
+
"line": 156
|
|
3946
4043
|
},
|
|
3947
4044
|
"name": "addAuthorizationRule",
|
|
3948
4045
|
"parameters": [
|
|
3949
4046
|
{
|
|
4047
|
+
"docs": {
|
|
4048
|
+
"remarks": "A unique identifier for the Authorization Rule within the Event Hub.\n - `listen`: Optional. Specifies if the rule allows listening to the Event Hub. Defaults to false.\n - `send`: Optional. Specifies if the rule allows sending events to the Event Hub. Defaults to false.\n - `manage`: Optional. Specifies if the rule allows managing the Event Hub. When set to true,\n both 'listen' and 'send' are implicitly enabled. Defaults to false.",
|
|
4049
|
+
"summary": "- The properties for the Authorization Rule, which include: - `name`: Required."
|
|
4050
|
+
},
|
|
3950
4051
|
"name": "props",
|
|
3951
4052
|
"type": {
|
|
3952
4053
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.AuthorizationRuleProps"
|
|
@@ -3961,21 +4062,35 @@
|
|
|
3961
4062
|
},
|
|
3962
4063
|
{
|
|
3963
4064
|
"docs": {
|
|
3964
|
-
"
|
|
4065
|
+
"custom": {
|
|
4066
|
+
"remarks": "Each consumer group can have multiple concurrent readers, but each partition in the Event Hub can only have one active consumer\nfrom a specific consumer group at a time. Multiple consumer groups enable multiple consuming applications to each have a separate\nview of the event stream, and to read the stream independently at their own pace and with their own offsets."
|
|
4067
|
+
},
|
|
4068
|
+
"remarks": "This method creates a new Consumer Group for the specified Event Hub. Consumer groups represent a view of the entire Event Hub,\nallowing consumer applications to have separate, independent views of the event stream. They read the stream at their own pace\nand maintain their own sequence point or offset. This enables a single Event Hub to support multiple consumer applications.",
|
|
4069
|
+
"returns": "An instance of the ConsumerGroup class, configured with the specified properties and associated with the Event Hub\nspecified in the enclosing construct's properties.\n\nExample usage:\n```typescript\nconst myConsumerGroup = eventHubInstance.addConsumerGroup('myConsumerGroupName', 'Metadata about this consumer group');\n```",
|
|
4070
|
+
"stability": "stable",
|
|
4071
|
+
"summary": "Adds a Consumer Group to an existing Event Hub instance."
|
|
3965
4072
|
},
|
|
3966
4073
|
"locationInModule": {
|
|
3967
4074
|
"filename": "src/azure-eventhub/lib/instance.ts",
|
|
3968
|
-
"line":
|
|
4075
|
+
"line": 189
|
|
3969
4076
|
},
|
|
3970
4077
|
"name": "addConsumerGroup",
|
|
3971
4078
|
"parameters": [
|
|
3972
4079
|
{
|
|
4080
|
+
"docs": {
|
|
4081
|
+
"remarks": "This name must be unique within the Event Hub namespace.",
|
|
4082
|
+
"summary": "- The name of the Consumer Group to be added."
|
|
4083
|
+
},
|
|
3973
4084
|
"name": "name",
|
|
3974
4085
|
"type": {
|
|
3975
4086
|
"primitive": "string"
|
|
3976
4087
|
}
|
|
3977
4088
|
},
|
|
3978
4089
|
{
|
|
4090
|
+
"docs": {
|
|
4091
|
+
"remarks": "User-defined metadata for the Consumer Group. This metadata is useful for storing additional\n information about the consumer group, such as its purpose or operational details.",
|
|
4092
|
+
"summary": "- Optional."
|
|
4093
|
+
},
|
|
3979
4094
|
"name": "userMetadata",
|
|
3980
4095
|
"optional": true,
|
|
3981
4096
|
"type": {
|
|
@@ -3991,15 +4106,22 @@
|
|
|
3991
4106
|
},
|
|
3992
4107
|
{
|
|
3993
4108
|
"docs": {
|
|
3994
|
-
"
|
|
4109
|
+
"remarks": "This method configures a new Kusto Data Connection linked to the specified EventHub. It facilitates the ingestion of streaming data\ninto the Kusto database, allowing for real-time analytics on streamed data. This connection specifies how data from EventHub\nis to be ingested into tables within the Kusto Database.",
|
|
4110
|
+
"returns": "An instance of the KustoDataConnection class, configured with the specified properties and linked to the EventHub\nspecified in the enclosing construct's properties.\n\nExample usage:\n```typescript\nconst kustoConnection = kustoInstance.addKustoDataConnection({\nname: 'myKustoDataConnection',\nlocation: 'West US',\nkustoResourceGroup: resourceGroup,\nkustoClusterName: 'myCluster',\nkustoDatabaseName: 'myDatabase',\ntableName: 'IngestionTable',\nconsumerGroup: '$Default',\ndataFormat: 'JSON'\n});\n```",
|
|
4111
|
+
"stability": "stable",
|
|
4112
|
+
"summary": "Adds a Kusto Data Connection to an existing Kusto Cluster and Database for ingesting data from an EventHub."
|
|
3995
4113
|
},
|
|
3996
4114
|
"locationInModule": {
|
|
3997
4115
|
"filename": "src/azure-eventhub/lib/instance.ts",
|
|
3998
|
-
"line":
|
|
4116
|
+
"line": 237
|
|
3999
4117
|
},
|
|
4000
4118
|
"name": "addKustoDataConnection",
|
|
4001
4119
|
"parameters": [
|
|
4002
4120
|
{
|
|
4121
|
+
"docs": {
|
|
4122
|
+
"remarks": "The name of the data connection to create.\n - `location`: Required. The Azure region where the data connection will be created.\n - `kustoResourceGroup`: Required. The Resource Group where the Kusto database exists.\n - `kustoClusterName`: Required. The name of the Kusto Cluster to which this data connection will be added.\n - `kustoDatabaseName`: Required. The name of the Kusto Database to which this data connection will be added.\n - `consumerGroup`: Optional. The EventHub consumer group used for ingestion. Defaults to \"$Default\".\n - `tableName`: Optional. The target table name in the Kusto database used for data ingestion.\n - `identityId`: Optional. The resource ID of a managed identity used for authentication with EventHub.\n - `mappingRuleName`: Optional. The mapping rule name used for data ingestion.\n - `dataFormat`: Optional. Specifies the data format of EventHub messages. Defaults to \"JSON\".\n - `databaseRoutingType`: Optional. Indicates the routing type for the database. Defaults to \"Single\".\n - `compression`: Optional. Specifies the compression type for the data connection. Defaults to \"None\".",
|
|
4123
|
+
"summary": "- The properties for the Kusto Data Connection, derived from BaseKustoDataConnectionProps, which include: - `name`: Required."
|
|
4124
|
+
},
|
|
4003
4125
|
"name": "props",
|
|
4004
4126
|
"type": {
|
|
4005
4127
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.BaseKustoDataConnectionProps"
|
|
@@ -4128,26 +4250,38 @@
|
|
|
4128
4250
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.KustoDataConnection",
|
|
4129
4251
|
"initializer": {
|
|
4130
4252
|
"docs": {
|
|
4131
|
-
"
|
|
4253
|
+
"remarks": "This class creates a data connection within a specified Kusto (Azure Data Explorer) database that connects\nto an Azure EventHub. This setup enables seamless data ingestion from EventHub into the Kusto database,\nallowing for real-time analytics on streamed data.",
|
|
4254
|
+
"stability": "stable",
|
|
4255
|
+
"summary": "Constructs a new Azure Kusto Data Connection for ingesting data from an EventHub."
|
|
4132
4256
|
},
|
|
4133
4257
|
"locationInModule": {
|
|
4134
4258
|
"filename": "src/azure-eventhub/lib/kusto-connection.ts",
|
|
4135
|
-
"line":
|
|
4259
|
+
"line": 124
|
|
4136
4260
|
},
|
|
4137
4261
|
"parameters": [
|
|
4138
4262
|
{
|
|
4263
|
+
"docs": {
|
|
4264
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
4265
|
+
},
|
|
4139
4266
|
"name": "scope",
|
|
4140
4267
|
"type": {
|
|
4141
4268
|
"fqn": "constructs.Construct"
|
|
4142
4269
|
}
|
|
4143
4270
|
},
|
|
4144
4271
|
{
|
|
4272
|
+
"docs": {
|
|
4273
|
+
"summary": "- The unique identifier for this instance of the data connection."
|
|
4274
|
+
},
|
|
4145
4275
|
"name": "id",
|
|
4146
4276
|
"type": {
|
|
4147
4277
|
"primitive": "string"
|
|
4148
4278
|
}
|
|
4149
4279
|
},
|
|
4150
4280
|
{
|
|
4281
|
+
"docs": {
|
|
4282
|
+
"remarks": "These properties include:\n- `name`: Required. The name of the data connection.\n- `location`: Required. The Azure region where the data connection will be created.\n- `kustoResourceGroup`: Required. The Resource Group where the Kusto database exists.\n- `kustoClusterName`: Required. The name of the Kusto Cluster to which this data connection will be added.\n- `kustoDatabaseName`: Required. The name of the Kusto Database to which this data connection will be added.\n- `eventhubId`: Required. The resource ID of the EventHub used for data ingestion.\n- `consumerGroup`: Optional. The EventHub consumer group used for ingestion. Defaults to \"$Default\".\n- `tableName`: Optional. The target table name in the Kusto database used for data ingestion.\n- `identityId`: Optional. The resource ID of a managed identity used for authentication with EventHub.\n- `mappingRuleName`: Optional. The mapping rule name used for data ingestion.\n- `dataFormat`: Optional. Specifies the data format of EventHub messages. Defaults to \"JSON\".\n- `databaseRoutingType`: Optional. Indicates the routing type for the database. Defaults to \"Single\".\n- `compression`: Optional. Specifies the compression type for the data connection. Defaults to \"None\".\n\nExample usage:\n```typescript\nconst kustoDataConnection = new KustoDataConnection(this, 'myDataConnection', {\nname: 'exampleDataConnection',\nlocation: 'East US',\nkustoResourceGroup: resourceGroup,\nkustoClusterName: 'exampleCluster',\nkustoDatabaseName: 'exampleDatabase',\neventhubId: '/subscriptions/{sub-id}/resourceGroups/{rg}/providers/Microsoft.EventHub/namespaces/{namespace}/eventhubs/{eventhub}',\nconsumerGroup: '$Default',\ntableName: 'destinationTable',\ndataFormat: 'JSON',\ndatabaseRoutingType: 'Single',\ncompression: 'None'\n});\n```",
|
|
4283
|
+
"summary": "- The properties for configuring the Kusto EventHub Data Connection."
|
|
4284
|
+
},
|
|
4151
4285
|
"name": "kustoDataConnectionProps",
|
|
4152
4286
|
"type": {
|
|
4153
4287
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.KustoDataConnectionProps"
|
|
@@ -4226,26 +4360,38 @@
|
|
|
4226
4360
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.Namespace",
|
|
4227
4361
|
"initializer": {
|
|
4228
4362
|
"docs": {
|
|
4229
|
-
"
|
|
4363
|
+
"remarks": "This class creates an Azure Event Hub Namespace, which serves as a container for all messaging components.\nNamespaces provide a scoping container for Event Hub resources within a specific region, which can be further\ncontrolled and managed using the provided settings.",
|
|
4364
|
+
"stability": "stable",
|
|
4365
|
+
"summary": "Constructs a new Event Hub Namespace."
|
|
4230
4366
|
},
|
|
4231
4367
|
"locationInModule": {
|
|
4232
4368
|
"filename": "src/azure-eventhub/lib/namespace.ts",
|
|
4233
|
-
"line":
|
|
4369
|
+
"line": 126
|
|
4234
4370
|
},
|
|
4235
4371
|
"parameters": [
|
|
4236
4372
|
{
|
|
4373
|
+
"docs": {
|
|
4374
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
4375
|
+
},
|
|
4237
4376
|
"name": "scope",
|
|
4238
4377
|
"type": {
|
|
4239
4378
|
"fqn": "constructs.Construct"
|
|
4240
4379
|
}
|
|
4241
4380
|
},
|
|
4242
4381
|
{
|
|
4382
|
+
"docs": {
|
|
4383
|
+
"summary": "- The unique name for this instance of the Event Hub Namespace."
|
|
4384
|
+
},
|
|
4243
4385
|
"name": "name",
|
|
4244
4386
|
"type": {
|
|
4245
4387
|
"primitive": "string"
|
|
4246
4388
|
}
|
|
4247
4389
|
},
|
|
4248
4390
|
{
|
|
4391
|
+
"docs": {
|
|
4392
|
+
"remarks": "These properties include:\n- `resourceGroup`: Required. The Azure Resource Group in which the namespace will be created.\n- `name`: Required. The name of the Event Hub Namespace to create.\n- `sku`: Optional. The SKU tier of the namespace (Basic, Standard, Premium). Defaults to \"Basic\".\n- `capacity`: Optional. Specifies the throughput units for a Standard SKU namespace. Defaults to 2.\n- `autoInflateEnabled`: Optional. Enables or disables Auto Inflate. Defaults to false.\n- `maximumThroughputUnits`: Optional. The maximum number of throughput units when Auto Inflate is enabled. Defaults to 2.\n- `zoneRedundant`: Optional. Specifies if the namespace should be zone redundant. Defaults to true.\n- `tags`: Optional. Tags for resource management and categorization.\n- `minimumTlsVersion`: Optional. Specifies the minimum supported TLS version. Defaults to \"1.2\".\n- `publicNetworkAccessEnabled`: Optional. Specifies if public network access is enabled. Defaults to true.\n- `localAuthenticationEnabled`: Optional. Specifies if SAS authentication is enabled. Defaults to false.\n- `identityType`: Optional. The type of Managed Service Identity. Defaults to \"SystemAssigned\".\n- `identityIds`: Optional. A list of User Assigned Managed Identity IDs.\n\nExample usage:\n```typescript\nconst eventHubNamespace = new Namespace(this, 'myNamespace', {\nresourceGroup: resourceGroup,\nname: 'myEventHubNamespace',\nsku: 'Standard',\ncapacity: 4,\nautoInflateEnabled: true,\nmaximumThroughputUnits: 10,\nzoneRedundant: false,\ntags: {\ndepartment: 'IT'\n},\nminimumTlsVersion: '1.2',\npublicNetworkAccessEnabled: false,\nlocalAuthenticationEnabled: true,\nidentityType: 'SystemAssigned'\n});\n```",
|
|
4393
|
+
"summary": "- The properties for configuring the Event Hub Namespace."
|
|
4394
|
+
},
|
|
4249
4395
|
"name": "ehNamespaceProps",
|
|
4250
4396
|
"type": {
|
|
4251
4397
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.NamespaceProps"
|
|
@@ -4261,15 +4407,25 @@
|
|
|
4261
4407
|
"methods": [
|
|
4262
4408
|
{
|
|
4263
4409
|
"docs": {
|
|
4264
|
-
"
|
|
4410
|
+
"custom": {
|
|
4411
|
+
"remarks": "Ensure that the namespace has sufficient capacity and configuration to support the properties of the Event Hub being created,\nespecially in terms of partition count and throughput units if applicable."
|
|
4412
|
+
},
|
|
4413
|
+
"remarks": "This method sets up a new Event Hub instance within the namespace defined by this class. An Event Hub instance\nserves as a container that processes and stores events. This method facilitates the setup of multiple Event Hubs\nwithin a single namespace, each configured according to the specified properties.",
|
|
4414
|
+
"returns": "An instance of the Event Hub (`Instance` class), configured with the specified properties.\n\nExample usage:\n```typescript\nconst eventHub = namespace.addEventhubInstance({\nname: 'myEventHub',\npartitionCount: 4,\nmessageRetention: 7,\nstatus: 'Active'\n});\n```",
|
|
4415
|
+
"stability": "stable",
|
|
4416
|
+
"summary": "Creates and adds an Event Hub instance to the current namespace."
|
|
4265
4417
|
},
|
|
4266
4418
|
"locationInModule": {
|
|
4267
4419
|
"filename": "src/azure-eventhub/lib/namespace.ts",
|
|
4268
|
-
"line":
|
|
4420
|
+
"line": 207
|
|
4269
4421
|
},
|
|
4270
4422
|
"name": "addEventhubInstance",
|
|
4271
4423
|
"parameters": [
|
|
4272
4424
|
{
|
|
4425
|
+
"docs": {
|
|
4426
|
+
"remarks": "These properties extend `BaseInstanceProps`, which include:\n - `name`: Required. The name of the Event Hub instance.\n - `partitionCount`: Optional. The number of partitions in the Event Hub. Default is 2.\n - `messageRetention`: Optional. The number of days to retain messages in the Event Hub. Default is 1.\n - `status`: Optional. The operational status of the Event Hub (Active, Disabled, SendDisabled). Default is \"Active\".\n Other properties from `BaseInstanceProps` can also be passed and will be used in the creation of the Event Hub.",
|
|
4427
|
+
"summary": "- The properties for configuring the new Event Hub instance."
|
|
4428
|
+
},
|
|
4273
4429
|
"name": "props",
|
|
4274
4430
|
"type": {
|
|
4275
4431
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_eventhub.BaseInstanceProps"
|
|
@@ -5337,26 +5493,38 @@
|
|
|
5337
5493
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.AccessPolicy",
|
|
5338
5494
|
"initializer": {
|
|
5339
5495
|
"docs": {
|
|
5340
|
-
"
|
|
5496
|
+
"remarks": "This class is responsible for setting up access policies that define what operations an Azure AD identity\ncan perform on the keys, secrets, certificates, and storage accounts within a specified Azure Key Vault.",
|
|
5497
|
+
"stability": "stable",
|
|
5498
|
+
"summary": "Constructs a new Access Policy for Azure Key Vault."
|
|
5341
5499
|
},
|
|
5342
5500
|
"locationInModule": {
|
|
5343
5501
|
"filename": "src/azure-keyvault/lib/policy.ts",
|
|
5344
|
-
"line":
|
|
5502
|
+
"line": 85
|
|
5345
5503
|
},
|
|
5346
5504
|
"parameters": [
|
|
5347
5505
|
{
|
|
5506
|
+
"docs": {
|
|
5507
|
+
"summary": "- The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack."
|
|
5508
|
+
},
|
|
5348
5509
|
"name": "scope",
|
|
5349
5510
|
"type": {
|
|
5350
5511
|
"fqn": "constructs.Construct"
|
|
5351
5512
|
}
|
|
5352
5513
|
},
|
|
5353
5514
|
{
|
|
5515
|
+
"docs": {
|
|
5516
|
+
"summary": "- The unique identifier for this instance of the access policy."
|
|
5517
|
+
},
|
|
5354
5518
|
"name": "id",
|
|
5355
5519
|
"type": {
|
|
5356
5520
|
"primitive": "string"
|
|
5357
5521
|
}
|
|
5358
5522
|
},
|
|
5359
5523
|
{
|
|
5524
|
+
"docs": {
|
|
5525
|
+
"remarks": "These include:\n - `keyVaultId`: The Azure Key Vault identifier where the policy will be set.\n - `tenantId`: The tenant ID of the Azure AD tenant where the Key Vault is hosted.\n - `objectId`: The object ID of the Azure AD identity (user, group, or service principal).\n - `secretPermissions`: Optional list of permissions to secrets within the Key Vault.\n - `certificatePermissions`: Optional list of permissions to certificates within the Key Vault.\n - `keyPermissions`: Optional list of permissions to keys within the Key Vault.\n - `storagePermissions`: Optional list of permissions to storage accounts linked to the Key Vault.\n\nExample usage:\n```typescript\nnew AccessPolicy(this, 'MyAccessPolicy', {\nkeyVaultId: myKeyVault,\ntenantId: 'my-tenant-id',\nobjectId: 'user-object-id',\nkeyPermissions: ['get', 'list', 'update'],\nsecretPermissions: ['get'],\ncertificatePermissions: ['get', 'list'],\nstoragePermissions: ['get', 'list']\n});\n```",
|
|
5526
|
+
"summary": "- The properties for creating the access policy as defined in AccessPolicyProps."
|
|
5527
|
+
},
|
|
5360
5528
|
"name": "props",
|
|
5361
5529
|
"type": {
|
|
5362
5530
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.AccessPolicyProps"
|
|
@@ -5558,26 +5726,38 @@
|
|
|
5558
5726
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.CertificateIssuer",
|
|
5559
5727
|
"initializer": {
|
|
5560
5728
|
"docs": {
|
|
5561
|
-
"
|
|
5729
|
+
"remarks": "This class is responsible for setting up a certificate issuer in Azure Key Vault. A certificate issuer is an entity\nthat issues digital certificates for use in SSL/TLS and other cryptographic security contexts. By configuring an issuer,\nyou can manage certificate lifecycle (issue, renew, revoke) through Azure Key Vault in conjunction with external certificate\nauthorities (CAs).",
|
|
5730
|
+
"stability": "stable",
|
|
5731
|
+
"summary": "Constructs a new Certificate Issuer within an Azure Key Vault."
|
|
5562
5732
|
},
|
|
5563
5733
|
"locationInModule": {
|
|
5564
5734
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5565
|
-
"line":
|
|
5735
|
+
"line": 216
|
|
5566
5736
|
},
|
|
5567
5737
|
"parameters": [
|
|
5568
5738
|
{
|
|
5739
|
+
"docs": {
|
|
5740
|
+
"summary": "- The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack."
|
|
5741
|
+
},
|
|
5569
5742
|
"name": "scope",
|
|
5570
5743
|
"type": {
|
|
5571
5744
|
"fqn": "constructs.Construct"
|
|
5572
5745
|
}
|
|
5573
5746
|
},
|
|
5574
5747
|
{
|
|
5748
|
+
"docs": {
|
|
5749
|
+
"summary": "- The unique identifier for this instance of the certificate issuer."
|
|
5750
|
+
},
|
|
5575
5751
|
"name": "id",
|
|
5576
5752
|
"type": {
|
|
5577
5753
|
"primitive": "string"
|
|
5578
5754
|
}
|
|
5579
5755
|
},
|
|
5580
5756
|
{
|
|
5757
|
+
"docs": {
|
|
5758
|
+
"remarks": "These properties include:\n - `name`: Required. The name of the issuer as it will appear in Azure Key Vault.\n - `providerName`: Required. The name of the provider that will issue the certificates, such as 'DigiCert' or 'GlobalSign'.\n - `keyVaultId`: Required. The ID of the Azure Key Vault where the issuer will be configured.\n - `accessPolicies`: Required. Access policies defining who can manage this issuer within the Key Vault.\n - `username`: Optional. The username required to authenticate with the certificate provider (if applicable).\n - `password`: Optional. The password required to authenticate with the certificate provider (if applicable).\n\nExample usage:\n```typescript\nnew CertificateIssuer(this, 'MyCertIssuer', {\nname: 'MyIssuer',\nproviderName: 'DigiCert',\nkeyVaultId: myKeyVault,\naccessPolicies: [{ userId: 'user123', permissions: ['manageIssuer'] }],\nusername: 'user@example.com',\npassword: 'securepassword'\n});\n```",
|
|
5759
|
+
"summary": "- The properties for configuring the certificate issuer as defined in CertificateIssuerProps."
|
|
5760
|
+
},
|
|
5581
5761
|
"name": "props",
|
|
5582
5762
|
"type": {
|
|
5583
5763
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.CertificateIssuerProps"
|
|
@@ -5588,7 +5768,7 @@
|
|
|
5588
5768
|
"kind": "class",
|
|
5589
5769
|
"locationInModule": {
|
|
5590
5770
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5591
|
-
"line":
|
|
5771
|
+
"line": 185
|
|
5592
5772
|
},
|
|
5593
5773
|
"name": "CertificateIssuer",
|
|
5594
5774
|
"namespace": "azure_keyvault",
|
|
@@ -5598,13 +5778,14 @@
|
|
|
5598
5778
|
"assembly": "@microsoft/terraform-cdk-constructs",
|
|
5599
5779
|
"datatype": true,
|
|
5600
5780
|
"docs": {
|
|
5601
|
-
"stability": "stable"
|
|
5781
|
+
"stability": "stable",
|
|
5782
|
+
"summary": "Properties required to configure a certificate issuer within Azure Key Vault."
|
|
5602
5783
|
},
|
|
5603
5784
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.CertificateIssuerProps",
|
|
5604
5785
|
"kind": "interface",
|
|
5605
5786
|
"locationInModule": {
|
|
5606
5787
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5607
|
-
"line":
|
|
5788
|
+
"line": 55
|
|
5608
5789
|
},
|
|
5609
5790
|
"name": "CertificateIssuerProps",
|
|
5610
5791
|
"namespace": "azure_keyvault",
|
|
@@ -5612,12 +5793,13 @@
|
|
|
5612
5793
|
{
|
|
5613
5794
|
"abstract": true,
|
|
5614
5795
|
"docs": {
|
|
5615
|
-
"stability": "stable"
|
|
5796
|
+
"stability": "stable",
|
|
5797
|
+
"summary": "Access policies defining who can manage this issuer and the certificates it issues within the Key Vault."
|
|
5616
5798
|
},
|
|
5617
5799
|
"immutable": true,
|
|
5618
5800
|
"locationInModule": {
|
|
5619
5801
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5620
|
-
"line":
|
|
5802
|
+
"line": 74
|
|
5621
5803
|
},
|
|
5622
5804
|
"name": "accessPolicies",
|
|
5623
5805
|
"type": {
|
|
@@ -5632,12 +5814,13 @@
|
|
|
5632
5814
|
{
|
|
5633
5815
|
"abstract": true,
|
|
5634
5816
|
"docs": {
|
|
5635
|
-
"stability": "stable"
|
|
5817
|
+
"stability": "stable",
|
|
5818
|
+
"summary": "The ID of the Azure Key Vault where the issuer will be configured."
|
|
5636
5819
|
},
|
|
5637
5820
|
"immutable": true,
|
|
5638
5821
|
"locationInModule": {
|
|
5639
5822
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5640
|
-
"line":
|
|
5823
|
+
"line": 69
|
|
5641
5824
|
},
|
|
5642
5825
|
"name": "keyVaultId",
|
|
5643
5826
|
"type": {
|
|
@@ -5648,12 +5831,12 @@
|
|
|
5648
5831
|
"abstract": true,
|
|
5649
5832
|
"docs": {
|
|
5650
5833
|
"stability": "stable",
|
|
5651
|
-
"summary": "The name of the certificate issuer in
|
|
5834
|
+
"summary": "The name of the certificate issuer as it will appear in Azure Key Vault."
|
|
5652
5835
|
},
|
|
5653
5836
|
"immutable": true,
|
|
5654
5837
|
"locationInModule": {
|
|
5655
5838
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5656
|
-
"line":
|
|
5839
|
+
"line": 59
|
|
5657
5840
|
},
|
|
5658
5841
|
"name": "name",
|
|
5659
5842
|
"type": {
|
|
@@ -5663,12 +5846,13 @@
|
|
|
5663
5846
|
{
|
|
5664
5847
|
"abstract": true,
|
|
5665
5848
|
"docs": {
|
|
5666
|
-
"stability": "stable"
|
|
5849
|
+
"stability": "stable",
|
|
5850
|
+
"summary": "The name of the provider that will issue the certificate, such as 'DigiCert' or 'GlobalSign'."
|
|
5667
5851
|
},
|
|
5668
5852
|
"immutable": true,
|
|
5669
5853
|
"locationInModule": {
|
|
5670
5854
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5671
|
-
"line":
|
|
5855
|
+
"line": 64
|
|
5672
5856
|
},
|
|
5673
5857
|
"name": "providerName",
|
|
5674
5858
|
"type": {
|
|
@@ -5678,12 +5862,13 @@
|
|
|
5678
5862
|
{
|
|
5679
5863
|
"abstract": true,
|
|
5680
5864
|
"docs": {
|
|
5681
|
-
"stability": "stable"
|
|
5865
|
+
"stability": "stable",
|
|
5866
|
+
"summary": "The password required to authenticate with the certificate provider (if applicable)."
|
|
5682
5867
|
},
|
|
5683
5868
|
"immutable": true,
|
|
5684
5869
|
"locationInModule": {
|
|
5685
5870
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5686
|
-
"line":
|
|
5871
|
+
"line": 84
|
|
5687
5872
|
},
|
|
5688
5873
|
"name": "password",
|
|
5689
5874
|
"optional": true,
|
|
@@ -5694,12 +5879,13 @@
|
|
|
5694
5879
|
{
|
|
5695
5880
|
"abstract": true,
|
|
5696
5881
|
"docs": {
|
|
5697
|
-
"stability": "stable"
|
|
5882
|
+
"stability": "stable",
|
|
5883
|
+
"summary": "The username required to authenticate with the certificate provider (if applicable)."
|
|
5698
5884
|
},
|
|
5699
5885
|
"immutable": true,
|
|
5700
5886
|
"locationInModule": {
|
|
5701
5887
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
5702
|
-
"line":
|
|
5888
|
+
"line": 79
|
|
5703
5889
|
},
|
|
5704
5890
|
"name": "username",
|
|
5705
5891
|
"optional": true,
|
|
@@ -5830,26 +6016,38 @@
|
|
|
5830
6016
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.Key",
|
|
5831
6017
|
"initializer": {
|
|
5832
6018
|
"docs": {
|
|
5833
|
-
"
|
|
6019
|
+
"remarks": "This class is responsible for the creation and management of a cryptographic key stored in Azure Key Vault.\nThe key can be used for a variety of cryptographic operations, such as encryption, decryption, signing, or\nverifying signatures, depending on the permissions granted. It supports different key types and configurations,\nallowing for customization to meet specific security requirements.",
|
|
6020
|
+
"stability": "stable",
|
|
6021
|
+
"summary": "Constructs a new Key resource in Azure Key Vault."
|
|
5834
6022
|
},
|
|
5835
6023
|
"locationInModule": {
|
|
5836
6024
|
"filename": "src/azure-keyvault/lib/key.ts",
|
|
5837
|
-
"line":
|
|
6025
|
+
"line": 84
|
|
5838
6026
|
},
|
|
5839
6027
|
"parameters": [
|
|
5840
6028
|
{
|
|
6029
|
+
"docs": {
|
|
6030
|
+
"summary": "- The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack."
|
|
6031
|
+
},
|
|
5841
6032
|
"name": "scope",
|
|
5842
6033
|
"type": {
|
|
5843
6034
|
"fqn": "constructs.Construct"
|
|
5844
6035
|
}
|
|
5845
6036
|
},
|
|
5846
6037
|
{
|
|
6038
|
+
"docs": {
|
|
6039
|
+
"summary": "- The unique identifier for this instance of the Key."
|
|
6040
|
+
},
|
|
5847
6041
|
"name": "id",
|
|
5848
6042
|
"type": {
|
|
5849
6043
|
"primitive": "string"
|
|
5850
6044
|
}
|
|
5851
6045
|
},
|
|
5852
6046
|
{
|
|
6047
|
+
"docs": {
|
|
6048
|
+
"remarks": "These properties include:\n - `name`: Required. The name of the key as it will appear in Azure Key Vault.\n - `keyVaultId`: Required. The ID of the Azure Key Vault where the key will be created.\n - `keyType`: Required. The type of cryptographic key to create (e.g., RSA, EC).\n - `keySize`: Optional. The size of the key, typically specified for RSA keys.\n - `keyOpts`: Optional. Additional options or attributes related to the key's capabilities such as encrypt, decrypt, wrapKey, unwrapKey.\n - `rotationPolicy`: Optional. The policy settings for rotating the key automatically.\n - `expires`: Optional. The expiration date of the key in UTC format (YYYY-MM-DDTHH:MM:SSZ).\n - `accessPolicies`: Required. Access policies defining who can access this key within the Key Vault.\n\nExample usage:\n```typescript\nnew Key(this, 'myKey', {\nname: 'encryptionKey',\nkeyVaultId: myKeyVault,\nkeyType: 'RSA',\nkeySize: 2048,\nkeyOpts: ['encrypt', 'decrypt', 'sign', 'verify'],\nrotationPolicy: {\nexpiryTime: 'P90D'\n},\nexpires: '2030-01-01T00:00:00Z',\naccessPolicies: [{ userId: 'user123', permissions: ['get', 'list', 'update'] }]\n});\n```",
|
|
6049
|
+
"summary": "- The properties for creating the key as defined in KeyProps."
|
|
6050
|
+
},
|
|
5853
6051
|
"name": "props",
|
|
5854
6052
|
"type": {
|
|
5855
6053
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.KeyProps"
|
|
@@ -6048,26 +6246,38 @@
|
|
|
6048
6246
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.Secret",
|
|
6049
6247
|
"initializer": {
|
|
6050
6248
|
"docs": {
|
|
6051
|
-
"
|
|
6249
|
+
"remarks": "This class facilitates the creation and management of a secret, allowing sensitive information to be stored securely\nand accessed as needed while maintaining confidentiality and control through defined access policies.",
|
|
6250
|
+
"stability": "stable",
|
|
6251
|
+
"summary": "Constructs a new Azure Key Vault Secret within a specified Key Vault."
|
|
6052
6252
|
},
|
|
6053
6253
|
"locationInModule": {
|
|
6054
6254
|
"filename": "src/azure-keyvault/lib/secret.ts",
|
|
6055
|
-
"line":
|
|
6255
|
+
"line": 78
|
|
6056
6256
|
},
|
|
6057
6257
|
"parameters": [
|
|
6058
6258
|
{
|
|
6259
|
+
"docs": {
|
|
6260
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
6261
|
+
},
|
|
6059
6262
|
"name": "scope",
|
|
6060
6263
|
"type": {
|
|
6061
6264
|
"fqn": "constructs.Construct"
|
|
6062
6265
|
}
|
|
6063
6266
|
},
|
|
6064
6267
|
{
|
|
6268
|
+
"docs": {
|
|
6269
|
+
"summary": "- The unique identifier for this instance of the secret."
|
|
6270
|
+
},
|
|
6065
6271
|
"name": "id",
|
|
6066
6272
|
"type": {
|
|
6067
6273
|
"primitive": "string"
|
|
6068
6274
|
}
|
|
6069
6275
|
},
|
|
6070
6276
|
{
|
|
6277
|
+
"docs": {
|
|
6278
|
+
"remarks": "These include:\n - `keyVaultId`: The ID of the Key Vault in which to store the secret.\n - `name`: The name of the secret.\n - `value`: The confidential data to be stored as the secret.\n - `expirationDate`: Optional. The expiration date of the secret.\n - `contentType`: Optional. A label hinting at the content type of the secret's value.\n - `accessPolicies`: Access policies that dictate permissions for the secret.\n\nExample usage:\n```typescript\nnew Secret(this, 'mySecret', {\nkeyVaultId: myKeyVault,\nname: 'dbPassword',\nvalue: 'p@ssw0rd!',\nexpirationDate: '2030-01-01T00:00:00Z',\ncontentType: 'password',\naccessPolicies: [{\nobjectId: '12345-user-object-id',\npermissions: ['get', 'list']\n}]\n});\n```",
|
|
6279
|
+
"summary": "- The properties for creating the secret as defined in SecretProps."
|
|
6280
|
+
},
|
|
6071
6281
|
"name": "props",
|
|
6072
6282
|
"type": {
|
|
6073
6283
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.SecretProps"
|
|
@@ -6235,26 +6445,38 @@
|
|
|
6235
6445
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.SelfSignedCertificate",
|
|
6236
6446
|
"initializer": {
|
|
6237
6447
|
"docs": {
|
|
6238
|
-
"
|
|
6448
|
+
"remarks": "This class is responsible for the creation and management of a self-signed certificate, making it available\nwithin an Azure Key Vault. The certificate can be used for testing or internal secure communications.",
|
|
6449
|
+
"stability": "stable",
|
|
6450
|
+
"summary": "Constructs a self-signed certificate within an Azure Key Vault."
|
|
6239
6451
|
},
|
|
6240
6452
|
"locationInModule": {
|
|
6241
6453
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6242
|
-
"line":
|
|
6454
|
+
"line": 114
|
|
6243
6455
|
},
|
|
6244
6456
|
"parameters": [
|
|
6245
6457
|
{
|
|
6458
|
+
"docs": {
|
|
6459
|
+
"summary": "- The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack."
|
|
6460
|
+
},
|
|
6246
6461
|
"name": "scope",
|
|
6247
6462
|
"type": {
|
|
6248
6463
|
"fqn": "constructs.Construct"
|
|
6249
6464
|
}
|
|
6250
6465
|
},
|
|
6251
6466
|
{
|
|
6467
|
+
"docs": {
|
|
6468
|
+
"summary": "- The unique identifier for this instance of the certificate."
|
|
6469
|
+
},
|
|
6252
6470
|
"name": "id",
|
|
6253
6471
|
"type": {
|
|
6254
6472
|
"primitive": "string"
|
|
6255
6473
|
}
|
|
6256
6474
|
},
|
|
6257
6475
|
{
|
|
6476
|
+
"docs": {
|
|
6477
|
+
"remarks": "Example usage:\n```typescript\nnew SelfSignedCertificate(this, 'MySelfSignedCert', {\nname: 'exampleCert',\nsubject: 'CN=example.com',\ndnsNames: ['example.com', 'www.example.com'],\nkeyVaultId: myKeyVault,\naccessPolicies: [{ userId: 'user123', permissions: ['all'] }],\ntags: { project: 'My Project' }\n});\n```",
|
|
6478
|
+
"summary": "- The properties for creating the self-signed certificate as defined in SelfSignedCertificateProps."
|
|
6479
|
+
},
|
|
6258
6480
|
"name": "props",
|
|
6259
6481
|
"type": {
|
|
6260
6482
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.SelfSignedCertificateProps"
|
|
@@ -6265,7 +6487,7 @@
|
|
|
6265
6487
|
"kind": "class",
|
|
6266
6488
|
"locationInModule": {
|
|
6267
6489
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6268
|
-
"line":
|
|
6490
|
+
"line": 87
|
|
6269
6491
|
},
|
|
6270
6492
|
"name": "SelfSignedCertificate",
|
|
6271
6493
|
"namespace": "azure_keyvault",
|
|
@@ -6276,7 +6498,7 @@
|
|
|
6276
6498
|
},
|
|
6277
6499
|
"locationInModule": {
|
|
6278
6500
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6279
|
-
"line":
|
|
6501
|
+
"line": 88
|
|
6280
6502
|
},
|
|
6281
6503
|
"name": "certificate",
|
|
6282
6504
|
"type": {
|
|
@@ -6289,7 +6511,7 @@
|
|
|
6289
6511
|
},
|
|
6290
6512
|
"locationInModule": {
|
|
6291
6513
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6292
|
-
"line":
|
|
6514
|
+
"line": 89
|
|
6293
6515
|
},
|
|
6294
6516
|
"name": "id",
|
|
6295
6517
|
"type": {
|
|
@@ -6302,7 +6524,7 @@
|
|
|
6302
6524
|
},
|
|
6303
6525
|
"locationInModule": {
|
|
6304
6526
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6305
|
-
"line":
|
|
6527
|
+
"line": 90
|
|
6306
6528
|
},
|
|
6307
6529
|
"name": "secretId",
|
|
6308
6530
|
"type": {
|
|
@@ -6316,13 +6538,14 @@
|
|
|
6316
6538
|
"assembly": "@microsoft/terraform-cdk-constructs",
|
|
6317
6539
|
"datatype": true,
|
|
6318
6540
|
"docs": {
|
|
6319
|
-
"stability": "stable"
|
|
6541
|
+
"stability": "stable",
|
|
6542
|
+
"summary": "Properties required to create a self-signed certificate within Azure Key Vault."
|
|
6320
6543
|
},
|
|
6321
6544
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.SelfSignedCertificateProps",
|
|
6322
6545
|
"kind": "interface",
|
|
6323
6546
|
"locationInModule": {
|
|
6324
6547
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6325
|
-
"line":
|
|
6548
|
+
"line": 10
|
|
6326
6549
|
},
|
|
6327
6550
|
"name": "SelfSignedCertificateProps",
|
|
6328
6551
|
"namespace": "azure_keyvault",
|
|
@@ -6330,12 +6553,13 @@
|
|
|
6330
6553
|
{
|
|
6331
6554
|
"abstract": true,
|
|
6332
6555
|
"docs": {
|
|
6333
|
-
"stability": "stable"
|
|
6556
|
+
"stability": "stable",
|
|
6557
|
+
"summary": "Access policies defining who can access this certificate within the Azure Key Vault."
|
|
6334
6558
|
},
|
|
6335
6559
|
"immutable": true,
|
|
6336
6560
|
"locationInModule": {
|
|
6337
6561
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6338
|
-
"line":
|
|
6562
|
+
"line": 44
|
|
6339
6563
|
},
|
|
6340
6564
|
"name": "accessPolicies",
|
|
6341
6565
|
"type": {
|
|
@@ -6350,12 +6574,14 @@
|
|
|
6350
6574
|
{
|
|
6351
6575
|
"abstract": true,
|
|
6352
6576
|
"docs": {
|
|
6353
|
-
"
|
|
6577
|
+
"remarks": "Useful for creating certificates valid for multiple hostnames.",
|
|
6578
|
+
"stability": "stable",
|
|
6579
|
+
"summary": "Additional DNS names to be included in the certificate."
|
|
6354
6580
|
},
|
|
6355
6581
|
"immutable": true,
|
|
6356
6582
|
"locationInModule": {
|
|
6357
6583
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6358
|
-
"line":
|
|
6584
|
+
"line": 24
|
|
6359
6585
|
},
|
|
6360
6586
|
"name": "dnsNames",
|
|
6361
6587
|
"type": {
|
|
@@ -6370,12 +6596,13 @@
|
|
|
6370
6596
|
{
|
|
6371
6597
|
"abstract": true,
|
|
6372
6598
|
"docs": {
|
|
6373
|
-
"stability": "stable"
|
|
6599
|
+
"stability": "stable",
|
|
6600
|
+
"summary": "The ID of the Azure Key Vault where the certificate will be created and stored."
|
|
6374
6601
|
},
|
|
6375
6602
|
"immutable": true,
|
|
6376
6603
|
"locationInModule": {
|
|
6377
6604
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6378
|
-
"line":
|
|
6605
|
+
"line": 29
|
|
6379
6606
|
},
|
|
6380
6607
|
"name": "keyVaultId",
|
|
6381
6608
|
"type": {
|
|
@@ -6386,12 +6613,12 @@
|
|
|
6386
6613
|
"abstract": true,
|
|
6387
6614
|
"docs": {
|
|
6388
6615
|
"stability": "stable",
|
|
6389
|
-
"summary": "The name of the certificate in
|
|
6616
|
+
"summary": "The name of the certificate to be stored in Azure Key Vault."
|
|
6390
6617
|
},
|
|
6391
6618
|
"immutable": true,
|
|
6392
6619
|
"locationInModule": {
|
|
6393
6620
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6394
|
-
"line":
|
|
6621
|
+
"line": 14
|
|
6395
6622
|
},
|
|
6396
6623
|
"name": "name",
|
|
6397
6624
|
"type": {
|
|
@@ -6401,12 +6628,13 @@
|
|
|
6401
6628
|
{
|
|
6402
6629
|
"abstract": true,
|
|
6403
6630
|
"docs": {
|
|
6404
|
-
"stability": "stable"
|
|
6631
|
+
"stability": "stable",
|
|
6632
|
+
"summary": "The subject name for the certificate, typically represented in X.509 distinguished name format."
|
|
6405
6633
|
},
|
|
6406
6634
|
"immutable": true,
|
|
6407
6635
|
"locationInModule": {
|
|
6408
6636
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6409
|
-
"line":
|
|
6637
|
+
"line": 19
|
|
6410
6638
|
},
|
|
6411
6639
|
"name": "subject",
|
|
6412
6640
|
"type": {
|
|
@@ -6416,12 +6644,13 @@
|
|
|
6416
6644
|
{
|
|
6417
6645
|
"abstract": true,
|
|
6418
6646
|
"docs": {
|
|
6419
|
-
"stability": "stable"
|
|
6647
|
+
"stability": "stable",
|
|
6648
|
+
"summary": "Specifies the type of action to perform with the certificate, such as 'create' or 'renew'."
|
|
6420
6649
|
},
|
|
6421
6650
|
"immutable": true,
|
|
6422
6651
|
"locationInModule": {
|
|
6423
6652
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6424
|
-
"line":
|
|
6653
|
+
"line": 34
|
|
6425
6654
|
},
|
|
6426
6655
|
"name": "actionType",
|
|
6427
6656
|
"optional": true,
|
|
@@ -6432,12 +6661,13 @@
|
|
|
6432
6661
|
{
|
|
6433
6662
|
"abstract": true,
|
|
6434
6663
|
"docs": {
|
|
6435
|
-
"stability": "stable"
|
|
6664
|
+
"stability": "stable",
|
|
6665
|
+
"summary": "Specifies the number of days before expiry when an action should be taken (e.g., renew the certificate)."
|
|
6436
6666
|
},
|
|
6437
6667
|
"immutable": true,
|
|
6438
6668
|
"locationInModule": {
|
|
6439
6669
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6440
|
-
"line":
|
|
6670
|
+
"line": 39
|
|
6441
6671
|
},
|
|
6442
6672
|
"name": "daysBeforeExpiry",
|
|
6443
6673
|
"optional": true,
|
|
@@ -6448,12 +6678,13 @@
|
|
|
6448
6678
|
{
|
|
6449
6679
|
"abstract": true,
|
|
6450
6680
|
"docs": {
|
|
6451
|
-
"stability": "stable"
|
|
6681
|
+
"stability": "stable",
|
|
6682
|
+
"summary": "Tags to be associated with the certificate for organizational purposes."
|
|
6452
6683
|
},
|
|
6453
6684
|
"immutable": true,
|
|
6454
6685
|
"locationInModule": {
|
|
6455
6686
|
"filename": "src/azure-keyvault/lib/certificate.ts",
|
|
6456
|
-
"line":
|
|
6687
|
+
"line": 49
|
|
6457
6688
|
},
|
|
6458
6689
|
"name": "tags",
|
|
6459
6690
|
"optional": true,
|
|
@@ -6478,26 +6709,38 @@
|
|
|
6478
6709
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.Vault",
|
|
6479
6710
|
"initializer": {
|
|
6480
6711
|
"docs": {
|
|
6481
|
-
"
|
|
6712
|
+
"remarks": "This class creates and configures an Azure Key Vault, a secure store for managing secrets, keys, certificates, and other sensitive data.\nIt supports advanced configurations such as access policies, network rules, and data retention policies.",
|
|
6713
|
+
"stability": "stable",
|
|
6714
|
+
"summary": "Constructs a new Azure Key Vault resource."
|
|
6482
6715
|
},
|
|
6483
6716
|
"locationInModule": {
|
|
6484
6717
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6485
|
-
"line":
|
|
6718
|
+
"line": 128
|
|
6486
6719
|
},
|
|
6487
6720
|
"parameters": [
|
|
6488
6721
|
{
|
|
6722
|
+
"docs": {
|
|
6723
|
+
"summary": "- The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack."
|
|
6724
|
+
},
|
|
6489
6725
|
"name": "scope",
|
|
6490
6726
|
"type": {
|
|
6491
6727
|
"fqn": "constructs.Construct"
|
|
6492
6728
|
}
|
|
6493
6729
|
},
|
|
6494
6730
|
{
|
|
6731
|
+
"docs": {
|
|
6732
|
+
"summary": "- The unique identifier for this instance of the Key Vault."
|
|
6733
|
+
},
|
|
6495
6734
|
"name": "id",
|
|
6496
6735
|
"type": {
|
|
6497
6736
|
"primitive": "string"
|
|
6498
6737
|
}
|
|
6499
6738
|
},
|
|
6500
6739
|
{
|
|
6740
|
+
"docs": {
|
|
6741
|
+
"remarks": "These include settings for location, SKU, tenant ID, etc.\n\nExample usage:\n```typescript\nnew Vault(this, 'MyKeyVault', {\nname: 'mySecureVault',\nlocation: 'East US',\nresourceGroup: myResourceGroup,\nsku: 'premium',\ntenantId: 'my-tenant-id',\nsoftDeleteRetentionDays: 90,\npurgeProtection: true,\ntags: {\nproject: 'My Application'\n}\n});\n```",
|
|
6742
|
+
"summary": "- The properties for creating the Key Vault as defined in VaultProps."
|
|
6743
|
+
},
|
|
6501
6744
|
"name": "props",
|
|
6502
6745
|
"type": {
|
|
6503
6746
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.VaultProps"
|
|
@@ -6513,21 +6756,30 @@
|
|
|
6513
6756
|
"methods": [
|
|
6514
6757
|
{
|
|
6515
6758
|
"docs": {
|
|
6516
|
-
"
|
|
6759
|
+
"remarks": "This method configures a certificate issuer within the Key Vault, allowing the Key Vault to issue certificates\nthrough external providers. Configuring an issuer is essential for enabling automated certificate management\nprocesses, such as issuance and renewal, directly through the Key Vault with a specified Certificate Authority (CA).",
|
|
6760
|
+
"stability": "stable",
|
|
6761
|
+
"summary": "Adds a certificate issuer to the Azure Key Vault."
|
|
6517
6762
|
},
|
|
6518
6763
|
"locationInModule": {
|
|
6519
6764
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6520
|
-
"line":
|
|
6765
|
+
"line": 555
|
|
6521
6766
|
},
|
|
6522
6767
|
"name": "addCertIssuer",
|
|
6523
6768
|
"parameters": [
|
|
6524
6769
|
{
|
|
6770
|
+
"docs": {
|
|
6771
|
+
"summary": "- The unique name for the certificate issuer within the Key Vault."
|
|
6772
|
+
},
|
|
6525
6773
|
"name": "name",
|
|
6526
6774
|
"type": {
|
|
6527
6775
|
"primitive": "string"
|
|
6528
6776
|
}
|
|
6529
6777
|
},
|
|
6530
6778
|
{
|
|
6779
|
+
"docs": {
|
|
6780
|
+
"remarks": "Example usage:\n```typescript\nvault.addCertIssuer(\n'myCertIssuer',\n'DigiCert'\n);\n```\nThis method configures a certificate issuer but does not return any value. The issuer details, including provider name\nand any necessary credentials (managed externally or through additional method parameters), are set up in the Key Vault\nfor future certificate operations.",
|
|
6781
|
+
"summary": "- The name of the external provider that will issue the certificates, such as 'DigiCert' or 'GlobalSign'."
|
|
6782
|
+
},
|
|
6531
6783
|
"name": "provider",
|
|
6532
6784
|
"type": {
|
|
6533
6785
|
"primitive": "string"
|
|
@@ -6537,33 +6789,49 @@
|
|
|
6537
6789
|
},
|
|
6538
6790
|
{
|
|
6539
6791
|
"docs": {
|
|
6540
|
-
"
|
|
6792
|
+
"remarks": "This method allows the creation of a cryptographic key of specified type and size within the Key Vault. The key can be\nconfigured with specific operations it can perform, such as encryption, decryption, signing, etc. An optional expiration\ndate can also be set to control the key's lifecycle. This method is flexible, supporting various key types and sizes,\nmaking it suitable for a wide range of cryptographic needs.",
|
|
6793
|
+
"returns": "A KeyVaultKey object representing the newly created cryptographic key within the vault.\n\nExample usage:\n```typescript\nconst myKey = vault.addKey(\n'myKey',\n'RSA',\n2048,\n['encrypt', 'decrypt', 'sign', 'verify'],\n'2030-12-31'\n);\n```\nThis method returns the created KeyVaultKey object, enabling immediate use within the application for cryptographic operations.",
|
|
6794
|
+
"stability": "stable",
|
|
6795
|
+
"summary": "Creates a cryptographic key within the Azure Key Vault."
|
|
6541
6796
|
},
|
|
6542
6797
|
"locationInModule": {
|
|
6543
6798
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6544
|
-
"line":
|
|
6799
|
+
"line": 465
|
|
6545
6800
|
},
|
|
6546
6801
|
"name": "addKey",
|
|
6547
6802
|
"parameters": [
|
|
6548
6803
|
{
|
|
6804
|
+
"docs": {
|
|
6805
|
+
"summary": "- The unique name for the cryptographic key within the Key Vault."
|
|
6806
|
+
},
|
|
6549
6807
|
"name": "keyVaultKeyName",
|
|
6550
6808
|
"type": {
|
|
6551
6809
|
"primitive": "string"
|
|
6552
6810
|
}
|
|
6553
6811
|
},
|
|
6554
6812
|
{
|
|
6813
|
+
"docs": {
|
|
6814
|
+
"summary": "- The type of cryptographic key to create (e.g., 'RSA', 'EC', 'oct-HSM')."
|
|
6815
|
+
},
|
|
6555
6816
|
"name": "keyType",
|
|
6556
6817
|
"type": {
|
|
6557
6818
|
"primitive": "string"
|
|
6558
6819
|
}
|
|
6559
6820
|
},
|
|
6560
6821
|
{
|
|
6822
|
+
"docs": {
|
|
6823
|
+
"summary": "- The size of the cryptographic key in bits (e.g., 2048, 3072, 4096 for RSA)."
|
|
6824
|
+
},
|
|
6561
6825
|
"name": "keySize",
|
|
6562
6826
|
"type": {
|
|
6563
6827
|
"primitive": "number"
|
|
6564
6828
|
}
|
|
6565
6829
|
},
|
|
6566
6830
|
{
|
|
6831
|
+
"docs": {
|
|
6832
|
+
"remarks": "Possible values might include\n 'encrypt', 'decrypt', 'sign', 'verify', 'wrapKey', 'unwrapKey'.",
|
|
6833
|
+
"summary": "- A list of cryptographic operations that the key is allowed to perform."
|
|
6834
|
+
},
|
|
6567
6835
|
"name": "keyOpts",
|
|
6568
6836
|
"type": {
|
|
6569
6837
|
"collection": {
|
|
@@ -6575,6 +6843,10 @@
|
|
|
6575
6843
|
}
|
|
6576
6844
|
},
|
|
6577
6845
|
{
|
|
6846
|
+
"docs": {
|
|
6847
|
+
"remarks": "The expiration date of the key in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).\n If provided, the key will no longer be valid after this date, aligning with best practices for key management.",
|
|
6848
|
+
"summary": "- Optional."
|
|
6849
|
+
},
|
|
6578
6850
|
"name": "expirationDate",
|
|
6579
6851
|
"optional": true,
|
|
6580
6852
|
"type": {
|
|
@@ -6590,21 +6862,31 @@
|
|
|
6590
6862
|
},
|
|
6591
6863
|
{
|
|
6592
6864
|
"docs": {
|
|
6593
|
-
"
|
|
6865
|
+
"remarks": "This method facilitates the creation of an RSA key, which is useful for a variety of cryptographic operations such as\nencryption, decryption, digital signature verification, and more. The RSA key created by this method is configurable\nwith an optional expiration date and a default key size of 2048 bits. The key operations allowed include decryption,\nencryption, signing, verifying signatures, and key wrapping/unwrapping.",
|
|
6866
|
+
"returns": "A KeyVaultKey object representing the newly created RSA key within the vault.\n\nExample usage:\n```typescript\nconst rsaKey = vault.addRSAKey(\n'myRSAKey',\n'2030-01-01'\n);\n```\nThis method returns the created KeyVaultKey object, allowing further operations or references to the key.",
|
|
6867
|
+
"stability": "stable",
|
|
6868
|
+
"summary": "Creates an RSA cryptographic key within the Azure Key Vault."
|
|
6594
6869
|
},
|
|
6595
6870
|
"locationInModule": {
|
|
6596
6871
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6597
|
-
"line":
|
|
6872
|
+
"line": 418
|
|
6598
6873
|
},
|
|
6599
6874
|
"name": "addRSAKey",
|
|
6600
6875
|
"parameters": [
|
|
6601
6876
|
{
|
|
6877
|
+
"docs": {
|
|
6878
|
+
"summary": "- The unique name for the RSA key within the Key Vault."
|
|
6879
|
+
},
|
|
6602
6880
|
"name": "keyVaultKeyName",
|
|
6603
6881
|
"type": {
|
|
6604
6882
|
"primitive": "string"
|
|
6605
6883
|
}
|
|
6606
6884
|
},
|
|
6607
6885
|
{
|
|
6886
|
+
"docs": {
|
|
6887
|
+
"remarks": "The expiration date of the key in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).\n If provided, the key will no longer be valid after this date.",
|
|
6888
|
+
"summary": "- Optional."
|
|
6889
|
+
},
|
|
6608
6890
|
"name": "expirationDate",
|
|
6609
6891
|
"optional": true,
|
|
6610
6892
|
"type": {
|
|
@@ -6620,27 +6902,39 @@
|
|
|
6620
6902
|
},
|
|
6621
6903
|
{
|
|
6622
6904
|
"docs": {
|
|
6623
|
-
"
|
|
6905
|
+
"remarks": "This method facilitates the storage of sensitive information in the form of a secret within the Key Vault.\nSecrets are protected items such as passwords, database connection strings, or any other piece of information\nthat needs to be securely stored and accessed. This method allows setting additional properties such as\nexpiration date and content type for better management and compliance.",
|
|
6906
|
+
"stability": "stable",
|
|
6907
|
+
"summary": "Creates a new secret within the Azure Key Vault."
|
|
6624
6908
|
},
|
|
6625
6909
|
"locationInModule": {
|
|
6626
6910
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6627
|
-
"line":
|
|
6911
|
+
"line": 378
|
|
6628
6912
|
},
|
|
6629
6913
|
"name": "addSecret",
|
|
6630
6914
|
"parameters": [
|
|
6631
6915
|
{
|
|
6916
|
+
"docs": {
|
|
6917
|
+
"summary": "- The unique name for the secret within the Key Vault."
|
|
6918
|
+
},
|
|
6632
6919
|
"name": "keyVaultSecretName",
|
|
6633
6920
|
"type": {
|
|
6634
6921
|
"primitive": "string"
|
|
6635
6922
|
}
|
|
6636
6923
|
},
|
|
6637
6924
|
{
|
|
6925
|
+
"docs": {
|
|
6926
|
+
"summary": "- The sensitive information or data that needs to be securely stored as a secret."
|
|
6927
|
+
},
|
|
6638
6928
|
"name": "secretValue",
|
|
6639
6929
|
"type": {
|
|
6640
6930
|
"primitive": "string"
|
|
6641
6931
|
}
|
|
6642
6932
|
},
|
|
6643
6933
|
{
|
|
6934
|
+
"docs": {
|
|
6935
|
+
"remarks": "The expiration date of the secret in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).\n If provided, the secret will no longer be valid after this date.",
|
|
6936
|
+
"summary": "- Optional."
|
|
6937
|
+
},
|
|
6644
6938
|
"name": "expirationDate",
|
|
6645
6939
|
"optional": true,
|
|
6646
6940
|
"type": {
|
|
@@ -6648,6 +6942,10 @@
|
|
|
6648
6942
|
}
|
|
6649
6943
|
},
|
|
6650
6944
|
{
|
|
6945
|
+
"docs": {
|
|
6946
|
+
"remarks": "A description of the type of information the secret contains (e.g., 'password', 'connectionString').\n This can be used by applications to handle the secret appropriately.\n\nExample usage:\n```typescript\nvault.addSecret(\n'myDatabasePassword',\n'p@ssw0rd123!',\n'2030-01-01',\n'databasePassword'\n);\n```\nThis method does not return a value. It creates a secret within the Key Vault with the specified properties.",
|
|
6947
|
+
"summary": "- Optional."
|
|
6948
|
+
},
|
|
6651
6949
|
"name": "contentType",
|
|
6652
6950
|
"optional": true,
|
|
6653
6951
|
"type": {
|
|
@@ -6658,27 +6956,40 @@
|
|
|
6658
6956
|
},
|
|
6659
6957
|
{
|
|
6660
6958
|
"docs": {
|
|
6661
|
-
"
|
|
6959
|
+
"remarks": "This method facilitates the creation of a self-signed certificate, which is a digital certificate that is signed by\nits own creator rather than a trusted authority. Self-signed certificates can be useful for testing, internal\ncommunications, or any scenario where public trust is not required. The method allows specifying subject details,\nDNS names for the certificate, and managing its lifecycle with action types and expiry.",
|
|
6960
|
+
"returns": "A KeyVaultCertificate object representing the newly created self-signed certificate.\n\nExample usage:\n```typescript\nconst myCertificate = vault.addSelfSignedCert(\n'myCert',\n'CN=mydomain.com',\n['mydomain.com', 'www.mydomain.com'],\n'create',\n30\n);\n```\nThis method returns the KeyVaultCertificate object, enabling it to be used immediately within the application or stored for future use.",
|
|
6961
|
+
"stability": "stable",
|
|
6962
|
+
"summary": "Creates a self-signed certificate within the Azure Key Vault."
|
|
6662
6963
|
},
|
|
6663
6964
|
"locationInModule": {
|
|
6664
6965
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6665
|
-
"line":
|
|
6966
|
+
"line": 514
|
|
6666
6967
|
},
|
|
6667
6968
|
"name": "addSelfSignedCert",
|
|
6668
6969
|
"parameters": [
|
|
6669
6970
|
{
|
|
6971
|
+
"docs": {
|
|
6972
|
+
"summary": "- The unique name for the certificate within the Key Vault."
|
|
6973
|
+
},
|
|
6670
6974
|
"name": "certName",
|
|
6671
6975
|
"type": {
|
|
6672
6976
|
"primitive": "string"
|
|
6673
6977
|
}
|
|
6674
6978
|
},
|
|
6675
6979
|
{
|
|
6980
|
+
"docs": {
|
|
6981
|
+
"summary": "- The subject name of the certificate, typically formatted as an X.500 Distinguished Name (e.g., \"CN=example.com\")."
|
|
6982
|
+
},
|
|
6676
6983
|
"name": "subject",
|
|
6677
6984
|
"type": {
|
|
6678
6985
|
"primitive": "string"
|
|
6679
6986
|
}
|
|
6680
6987
|
},
|
|
6681
6988
|
{
|
|
6989
|
+
"docs": {
|
|
6990
|
+
"remarks": "This is useful for certificates\n that need to be valid for multiple hostnames.",
|
|
6991
|
+
"summary": "- An array of DNS names that should be associated with this certificate."
|
|
6992
|
+
},
|
|
6682
6993
|
"name": "dnsNames",
|
|
6683
6994
|
"type": {
|
|
6684
6995
|
"collection": {
|
|
@@ -6690,6 +7001,10 @@
|
|
|
6690
7001
|
}
|
|
6691
7002
|
},
|
|
6692
7003
|
{
|
|
7004
|
+
"docs": {
|
|
7005
|
+
"remarks": "Specifies the action to be performed with the certificate, such as 'create' or 'renew'.",
|
|
7006
|
+
"summary": "- Optional."
|
|
7007
|
+
},
|
|
6693
7008
|
"name": "actionType",
|
|
6694
7009
|
"optional": true,
|
|
6695
7010
|
"type": {
|
|
@@ -6697,6 +7012,10 @@
|
|
|
6697
7012
|
}
|
|
6698
7013
|
},
|
|
6699
7014
|
{
|
|
7015
|
+
"docs": {
|
|
7016
|
+
"remarks": "Number of days before expiry when an action should be taken, useful for auto-renewal scenarios.",
|
|
7017
|
+
"summary": "- Optional."
|
|
7018
|
+
},
|
|
6700
7019
|
"name": "daysBeforeExpiry",
|
|
6701
7020
|
"optional": true,
|
|
6702
7021
|
"type": {
|
|
@@ -6712,15 +7031,19 @@
|
|
|
6712
7031
|
},
|
|
6713
7032
|
{
|
|
6714
7033
|
"docs": {
|
|
6715
|
-
"stability": "stable"
|
|
7034
|
+
"stability": "stable",
|
|
7035
|
+
"summary": "Grants administrative access to certificates stored in the Key Vault to a specified Azure AD group."
|
|
6716
7036
|
},
|
|
6717
7037
|
"locationInModule": {
|
|
6718
7038
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6719
|
-
"line":
|
|
7039
|
+
"line": 232
|
|
6720
7040
|
},
|
|
6721
7041
|
"name": "grantCertAdminAccess",
|
|
6722
7042
|
"parameters": [
|
|
6723
7043
|
{
|
|
7044
|
+
"docs": {
|
|
7045
|
+
"summary": "- The Azure Active Directory group ID that will receive administrative access to certificates."
|
|
7046
|
+
},
|
|
6724
7047
|
"name": "azureAdGroupId",
|
|
6725
7048
|
"type": {
|
|
6726
7049
|
"primitive": "string"
|
|
@@ -6730,15 +7053,19 @@
|
|
|
6730
7053
|
},
|
|
6731
7054
|
{
|
|
6732
7055
|
"docs": {
|
|
6733
|
-
"stability": "stable"
|
|
7056
|
+
"stability": "stable",
|
|
7057
|
+
"summary": "Grants read-only access to certificates stored in the Key Vault to a specified Azure AD group."
|
|
6734
7058
|
},
|
|
6735
7059
|
"locationInModule": {
|
|
6736
7060
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6737
|
-
"line":
|
|
7061
|
+
"line": 261
|
|
6738
7062
|
},
|
|
6739
7063
|
"name": "grantCertReaderAccess",
|
|
6740
7064
|
"parameters": [
|
|
6741
7065
|
{
|
|
7066
|
+
"docs": {
|
|
7067
|
+
"summary": "- The Azure Active Directory group ID that will receive read access to certificates."
|
|
7068
|
+
},
|
|
6742
7069
|
"name": "azureAdGroupId",
|
|
6743
7070
|
"type": {
|
|
6744
7071
|
"primitive": "string"
|
|
@@ -6748,21 +7075,28 @@
|
|
|
6748
7075
|
},
|
|
6749
7076
|
{
|
|
6750
7077
|
"docs": {
|
|
6751
|
-
"stability": "stable"
|
|
7078
|
+
"stability": "stable",
|
|
7079
|
+
"summary": "Grants custom access based on specified options to an Azure AD group in the Key Vault."
|
|
6752
7080
|
},
|
|
6753
7081
|
"locationInModule": {
|
|
6754
7082
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6755
|
-
"line":
|
|
7083
|
+
"line": 333
|
|
6756
7084
|
},
|
|
6757
7085
|
"name": "grantCustomAccess",
|
|
6758
7086
|
"parameters": [
|
|
6759
7087
|
{
|
|
7088
|
+
"docs": {
|
|
7089
|
+
"summary": "- The Azure Active Directory group ID that will receive the custom access."
|
|
7090
|
+
},
|
|
6760
7091
|
"name": "azureAdGroupId",
|
|
6761
7092
|
"type": {
|
|
6762
7093
|
"primitive": "string"
|
|
6763
7094
|
}
|
|
6764
7095
|
},
|
|
6765
7096
|
{
|
|
7097
|
+
"docs": {
|
|
7098
|
+
"summary": "- Custom access options specifying various permissions for secrets, keys, certificates, and storage."
|
|
7099
|
+
},
|
|
6766
7100
|
"name": "options",
|
|
6767
7101
|
"type": {
|
|
6768
7102
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_keyvault.GrantCustomAccessOptions"
|
|
@@ -6772,15 +7106,19 @@
|
|
|
6772
7106
|
},
|
|
6773
7107
|
{
|
|
6774
7108
|
"docs": {
|
|
6775
|
-
"stability": "stable"
|
|
7109
|
+
"stability": "stable",
|
|
7110
|
+
"summary": "Grants administrative access to keys stored in the Key Vault to a specified Azure AD group."
|
|
6776
7111
|
},
|
|
6777
7112
|
"locationInModule": {
|
|
6778
7113
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6779
|
-
"line":
|
|
7114
|
+
"line": 282
|
|
6780
7115
|
},
|
|
6781
7116
|
"name": "grantKeyAdminAccess",
|
|
6782
7117
|
"parameters": [
|
|
6783
7118
|
{
|
|
7119
|
+
"docs": {
|
|
7120
|
+
"summary": "- The Azure Active Directory group ID that will receive administrative access to keys."
|
|
7121
|
+
},
|
|
6784
7122
|
"name": "azureAdGroupId",
|
|
6785
7123
|
"type": {
|
|
6786
7124
|
"primitive": "string"
|
|
@@ -6790,15 +7128,19 @@
|
|
|
6790
7128
|
},
|
|
6791
7129
|
{
|
|
6792
7130
|
"docs": {
|
|
6793
|
-
"stability": "stable"
|
|
7131
|
+
"stability": "stable",
|
|
7132
|
+
"summary": "Grants read-only access to keys stored in the Key Vault to a specified Azure AD group."
|
|
6794
7133
|
},
|
|
6795
7134
|
"locationInModule": {
|
|
6796
7135
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6797
|
-
"line":
|
|
7136
|
+
"line": 311
|
|
6798
7137
|
},
|
|
6799
7138
|
"name": "grantKeyReaderAccess",
|
|
6800
7139
|
"parameters": [
|
|
6801
7140
|
{
|
|
7141
|
+
"docs": {
|
|
7142
|
+
"summary": "- The Azure Active Directory group ID that will receive read access to keys."
|
|
7143
|
+
},
|
|
6802
7144
|
"name": "azureAdGroupId",
|
|
6803
7145
|
"type": {
|
|
6804
7146
|
"primitive": "string"
|
|
@@ -6808,15 +7150,19 @@
|
|
|
6808
7150
|
},
|
|
6809
7151
|
{
|
|
6810
7152
|
"docs": {
|
|
6811
|
-
"stability": "stable"
|
|
7153
|
+
"stability": "stable",
|
|
7154
|
+
"summary": "Grants administrative access to secrets stored in the Key Vault to a specified Azure AD group."
|
|
6812
7155
|
},
|
|
6813
7156
|
"locationInModule": {
|
|
6814
7157
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6815
|
-
"line":
|
|
7158
|
+
"line": 203
|
|
6816
7159
|
},
|
|
6817
7160
|
"name": "grantSecretAdminAccess",
|
|
6818
7161
|
"parameters": [
|
|
6819
7162
|
{
|
|
7163
|
+
"docs": {
|
|
7164
|
+
"summary": "- The Azure Active Directory group ID that will receive administrative access to secrets."
|
|
7165
|
+
},
|
|
6820
7166
|
"name": "azureAdGroupId",
|
|
6821
7167
|
"type": {
|
|
6822
7168
|
"primitive": "string"
|
|
@@ -6826,15 +7172,19 @@
|
|
|
6826
7172
|
},
|
|
6827
7173
|
{
|
|
6828
7174
|
"docs": {
|
|
6829
|
-
"stability": "stable"
|
|
7175
|
+
"stability": "stable",
|
|
7176
|
+
"summary": "Grants read-only access to secrets stored in the Key Vault to a specified Azure AD group."
|
|
6830
7177
|
},
|
|
6831
7178
|
"locationInModule": {
|
|
6832
7179
|
"filename": "src/azure-keyvault/lib/vault.ts",
|
|
6833
|
-
"line":
|
|
7180
|
+
"line": 182
|
|
6834
7181
|
},
|
|
6835
7182
|
"name": "grantSecretReaderAccess",
|
|
6836
7183
|
"parameters": [
|
|
6837
7184
|
{
|
|
7185
|
+
"docs": {
|
|
7186
|
+
"summary": "- The Azure Active Directory group ID that will receive read access to secrets."
|
|
7187
|
+
},
|
|
6838
7188
|
"name": "azureAdGroupId",
|
|
6839
7189
|
"type": {
|
|
6840
7190
|
"primitive": "string"
|
|
@@ -7089,17 +7439,18 @@
|
|
|
7089
7439
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kubernetes.Cluster",
|
|
7090
7440
|
"initializer": {
|
|
7091
7441
|
"docs": {
|
|
7442
|
+
"remarks": "This class is responsible for the creation and management of an AKS cluster, allowing for the deployment and orchestration\nof containerized applications using Kubernetes within the Azure cloud platform.",
|
|
7092
7443
|
"stability": "stable",
|
|
7093
|
-
"summary": "
|
|
7444
|
+
"summary": "Represents an Azure Kubernetes Service (AKS) cluster resource in Azure."
|
|
7094
7445
|
},
|
|
7095
7446
|
"locationInModule": {
|
|
7096
7447
|
"filename": "src/azure-kubernetes/lib/cluster.ts",
|
|
7097
|
-
"line":
|
|
7448
|
+
"line": 106
|
|
7098
7449
|
},
|
|
7099
7450
|
"parameters": [
|
|
7100
7451
|
{
|
|
7101
7452
|
"docs": {
|
|
7102
|
-
"summary": "The scope in which to define this construct."
|
|
7453
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
7103
7454
|
},
|
|
7104
7455
|
"name": "scope",
|
|
7105
7456
|
"type": {
|
|
@@ -7108,7 +7459,7 @@
|
|
|
7108
7459
|
},
|
|
7109
7460
|
{
|
|
7110
7461
|
"docs": {
|
|
7111
|
-
"summary": "The unique
|
|
7462
|
+
"summary": "- The unique identifier for this instance of the AKS cluster."
|
|
7112
7463
|
},
|
|
7113
7464
|
"name": "id",
|
|
7114
7465
|
"type": {
|
|
@@ -7117,7 +7468,8 @@
|
|
|
7117
7468
|
},
|
|
7118
7469
|
{
|
|
7119
7470
|
"docs": {
|
|
7120
|
-
"
|
|
7471
|
+
"remarks": "Example usage:\n```typescript\nnew Cluster(this, 'MyAKSCluster', {\nname: 'example-cluster',\nlocation: 'East US',\ndefaultNodePool: {\nvmSize: 'Standard_D2_v3',\nnodeCount: 3,\ntype: 'VirtualMachineScaleSets'\n},\nresourceGroup: existingResourceGroup,\ntags: {\nenvironment: 'production'\n}\n});\n```",
|
|
7472
|
+
"summary": "- The properties required to configure the AKS cluster, as defined in the ClusterProps interface."
|
|
7121
7473
|
},
|
|
7122
7474
|
"name": "props",
|
|
7123
7475
|
"type": {
|
|
@@ -7344,26 +7696,38 @@
|
|
|
7344
7696
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kusto.Cluster",
|
|
7345
7697
|
"initializer": {
|
|
7346
7698
|
"docs": {
|
|
7347
|
-
"
|
|
7699
|
+
"remarks": "This class is responsible for the creation and management of a Kusto Cluster, which is a highly scalable and secure\nanalytics service for ingesting, storing, and analyzing large volumes of data. The cluster supports various configurations\ntailored to the needs of specific data workloads and security requirements.",
|
|
7700
|
+
"stability": "stable",
|
|
7701
|
+
"summary": "Represents a Kusto (Azure Data Explorer) cluster in Azure."
|
|
7348
7702
|
},
|
|
7349
7703
|
"locationInModule": {
|
|
7350
7704
|
"filename": "src/azure-kusto/lib/cluster.ts",
|
|
7351
|
-
"line":
|
|
7705
|
+
"line": 111
|
|
7352
7706
|
},
|
|
7353
7707
|
"parameters": [
|
|
7354
7708
|
{
|
|
7709
|
+
"docs": {
|
|
7710
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
7711
|
+
},
|
|
7355
7712
|
"name": "scope",
|
|
7356
7713
|
"type": {
|
|
7357
7714
|
"fqn": "constructs.Construct"
|
|
7358
7715
|
}
|
|
7359
7716
|
},
|
|
7360
7717
|
{
|
|
7718
|
+
"docs": {
|
|
7719
|
+
"summary": "- The unique identifier for this instance of the cluster."
|
|
7720
|
+
},
|
|
7361
7721
|
"name": "id",
|
|
7362
7722
|
"type": {
|
|
7363
7723
|
"primitive": "string"
|
|
7364
7724
|
}
|
|
7365
7725
|
},
|
|
7366
7726
|
{
|
|
7727
|
+
"docs": {
|
|
7728
|
+
"remarks": "Example usage:\n```typescript\nnew Cluster(this, 'MyKustoCluster', {\nname: 'example-cluster',\nlocation: 'West US',\nresourceGroup: myResourceGroup,\nsku: { tier: 'Standard', name: 'D13_v2', capacity: 2 },\ntags: {\nproject: 'Data Analytics'\n}\n});\n```",
|
|
7729
|
+
"summary": "- The properties required to configure the Kusto cluster, as defined in the ClusterProps interface."
|
|
7730
|
+
},
|
|
7367
7731
|
"name": "kustoProps",
|
|
7368
7732
|
"type": {
|
|
7369
7733
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kusto.ClusterProps"
|
|
@@ -7379,15 +7743,22 @@
|
|
|
7379
7743
|
"methods": [
|
|
7380
7744
|
{
|
|
7381
7745
|
"docs": {
|
|
7382
|
-
"
|
|
7746
|
+
"remarks": "This method creates a database within the Azure Data Explorer (Kusto) cluster, defined by the properties provided.\nA database in Kusto serves as a logical group to manage various tables and store data. It is essential for performing\ndata analytics and running queries. The database configuration can include settings like hot cache and soft delete periods,\nwhich optimize query performance and manage data lifecycle according to specific requirements.",
|
|
7747
|
+
"returns": "A `Database` object representing the newly created database within the Kusto cluster.\n\nExample usage:\n```typescript\nconst myDatabase = myCluster.addDatabase({\nkusto: myKustoCluster,\nname: 'OperationalData',\nhotCachePeriod: 'P14D', // 14 days\nsoftDeletePeriod: 'P365D' // 1 year\n});\n```\nThis method facilitates the efficient setup and scaling of databases within an Azure Kusto cluster, allowing\nfor complex data analytics operations across large datasets.",
|
|
7748
|
+
"stability": "stable",
|
|
7749
|
+
"summary": "Adds a new database to the Azure Kusto Cluster."
|
|
7383
7750
|
},
|
|
7384
7751
|
"locationInModule": {
|
|
7385
7752
|
"filename": "src/azure-kusto/lib/cluster.ts",
|
|
7386
|
-
"line":
|
|
7753
|
+
"line": 239
|
|
7387
7754
|
},
|
|
7388
7755
|
"name": "addDatabase",
|
|
7389
7756
|
"parameters": [
|
|
7390
7757
|
{
|
|
7758
|
+
"docs": {
|
|
7759
|
+
"remarks": "These properties should include:\n - `kusto`: Reference to the Kusto cluster to which the database will be added.\n - `name`: The name of the database, which must be unique within the cluster.\n - `hotCachePeriod`: Optional. Specifies the duration that data should be kept in cache for faster query access.\n - `softDeletePeriod`: Optional. Specifies the duration that data should be retained before it stops being accessible to queries.\n Both the hot cache and soft delete periods should be specified in ISO 8601 duration format.",
|
|
7760
|
+
"summary": "- The properties required to create the database."
|
|
7761
|
+
},
|
|
7391
7762
|
"name": "databaseProps",
|
|
7392
7763
|
"type": {
|
|
7393
7764
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kusto.DatabaseProps"
|
|
@@ -8598,26 +8969,38 @@
|
|
|
8598
8969
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kusto.Database",
|
|
8599
8970
|
"initializer": {
|
|
8600
8971
|
"docs": {
|
|
8601
|
-
"
|
|
8972
|
+
"remarks": "This class is responsible for the creation and management of a database in Azure Data Explorer (Kusto),\nwhich stores data tables and provides a query engine. A Kusto database is a logical group of tables\nand is associated with a specific Kusto cluster. The database supports configurations such as\nhot cache period and soft delete period to optimize performance and data retention according to\nspecific workload requirements.",
|
|
8973
|
+
"stability": "stable",
|
|
8974
|
+
"summary": "Represents a Kusto Database within an Azure Kusto Cluster."
|
|
8602
8975
|
},
|
|
8603
8976
|
"locationInModule": {
|
|
8604
8977
|
"filename": "src/azure-kusto/lib/database.ts",
|
|
8605
|
-
"line":
|
|
8978
|
+
"line": 97
|
|
8606
8979
|
},
|
|
8607
8980
|
"parameters": [
|
|
8608
8981
|
{
|
|
8982
|
+
"docs": {
|
|
8983
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
8984
|
+
},
|
|
8609
8985
|
"name": "scope",
|
|
8610
8986
|
"type": {
|
|
8611
8987
|
"fqn": "constructs.Construct"
|
|
8612
8988
|
}
|
|
8613
8989
|
},
|
|
8614
8990
|
{
|
|
8991
|
+
"docs": {
|
|
8992
|
+
"summary": "- The unique identifier for this instance of the Kusto database."
|
|
8993
|
+
},
|
|
8615
8994
|
"name": "id",
|
|
8616
8995
|
"type": {
|
|
8617
8996
|
"primitive": "string"
|
|
8618
8997
|
}
|
|
8619
8998
|
},
|
|
8620
8999
|
{
|
|
9000
|
+
"docs": {
|
|
9001
|
+
"remarks": "These include:\n - `kusto`: Reference to the Kusto cluster to which the database will belong.\n - `name`: The name of the database to be created within the Kusto cluster.\n - `hotCachePeriod`: Optional. Specifies the duration that data should be kept in cache for faster query performance.\n Expressed in ISO 8601 duration format.\n - `softDeletePeriod`: Optional. Specifies the duration that data should be retained before it stops being accessible.\n Expressed in ISO 8601 duration format.\n\nExample usage:\n```typescript\nconst myDatabase = new Database(this, 'MyKustoDatabase', {\nkusto: myKustoCluster,\nname: 'AnalyticsDB',\nhotCachePeriod: 'P30D', // 30 days\nsoftDeletePeriod: 'P365D' // 365 days\n});\n```\n\nThis class sets up the database configurations and integrates it within the specified Kusto cluster,\nproviding capabilities to manage and query large datasets effectively.",
|
|
9002
|
+
"summary": "- The properties required to configure the Kusto database."
|
|
9003
|
+
},
|
|
8621
9004
|
"name": "kustoDbProps",
|
|
8622
9005
|
"type": {
|
|
8623
9006
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kusto.DatabaseProps"
|
|
@@ -8633,15 +9016,21 @@
|
|
|
8633
9016
|
"methods": [
|
|
8634
9017
|
{
|
|
8635
9018
|
"docs": {
|
|
8636
|
-
"
|
|
9019
|
+
"remarks": "This method is used to grant access permissions to a specific user, group, or service principal within an Azure Active Directory.\nThese permissions determine the level of access that the principal has over the Kusto database, such as viewing, ingesting, or managing data.\nThe assignment is made by creating a KustoDatabasePrincipalAssignment resource, specifying the principal details and the type of role\nthey should assume.",
|
|
9020
|
+
"stability": "stable",
|
|
9021
|
+
"summary": "Adds a database principal assignment in the Kusto cluster, assigning specified access rights to a principal."
|
|
8637
9022
|
},
|
|
8638
9023
|
"locationInModule": {
|
|
8639
9024
|
"filename": "src/azure-kusto/lib/database.ts",
|
|
8640
|
-
"line":
|
|
9025
|
+
"line": 168
|
|
8641
9026
|
},
|
|
8642
9027
|
"name": "addPermission",
|
|
8643
9028
|
"parameters": [
|
|
8644
9029
|
{
|
|
9030
|
+
"docs": {
|
|
9031
|
+
"remarks": "This includes:\n- `name`: A unique name identifying this principal assignment.\n- `tenantId`: The Azure Active Directory tenant ID where the principal resides.\n- `principalId`: The object ID of the principal (user, group, or service principal) in Azure AD.\n- `principalType`: The type of principal (e.g., User, Group, App).\n- `role`: The database role assigned to the principal. Roles can include Admin, User, Viewer, among others.\n\nExample usage:\n```typescript\nmyDatabase.addPermission({\nname: 'DataScienceTeamAccess',\ntenantId: 'tenant-id',\nprincipalId: 'principal-id',\nprincipalType: 'Group',\nrole: 'Viewer'\n});\n```\nThis method creates a new principal assignment, enabling specified access controls for the principal\non the Kusto database based on the role assigned. It is crucial for managing security and access\ngovernance within the Kusto environment.",
|
|
9032
|
+
"summary": "- The properties defining the principal assignment."
|
|
9033
|
+
},
|
|
8645
9034
|
"name": "kustoDatabaseAccessProps",
|
|
8646
9035
|
"type": {
|
|
8647
9036
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_kusto.DatabaseAccessProps"
|
|
@@ -8651,21 +9040,30 @@
|
|
|
8651
9040
|
},
|
|
8652
9041
|
{
|
|
8653
9042
|
"docs": {
|
|
8654
|
-
"
|
|
9043
|
+
"remarks": "This method facilitates the execution of Kusto Query Language (KQL) scripts or control commands within the specified\nKusto database. Scripts can perform a variety of functions, from schema modifications, like adding new tables or altering\nexisting ones, to data management operations, such as data ingestion or cleanup tasks. Each script is executed as a\nKustoScript resource, which ensures that the script is applied correctly and atomically to the database.",
|
|
9044
|
+
"stability": "stable",
|
|
9045
|
+
"summary": "Adds and executes a control command or script within the Kusto database."
|
|
8655
9046
|
},
|
|
8656
9047
|
"locationInModule": {
|
|
8657
9048
|
"filename": "src/azure-kusto/lib/database.ts",
|
|
8658
|
-
"line":
|
|
9049
|
+
"line": 248
|
|
8659
9050
|
},
|
|
8660
9051
|
"name": "addScript",
|
|
8661
9052
|
"parameters": [
|
|
8662
9053
|
{
|
|
9054
|
+
"docs": {
|
|
9055
|
+
"summary": "- A unique name for the script, which helps in identifying the script resource within the deployment."
|
|
9056
|
+
},
|
|
8663
9057
|
"name": "scriptName",
|
|
8664
9058
|
"type": {
|
|
8665
9059
|
"primitive": "string"
|
|
8666
9060
|
}
|
|
8667
9061
|
},
|
|
8668
9062
|
{
|
|
9063
|
+
"docs": {
|
|
9064
|
+
"remarks": "Example usage:\n```typescript\nmyDatabase.addScript('InitializeSalesTable', `\n.create table SalesData (TransactionId: int, TransactionDate: datetime, Amount: real)\n.alter-merge table SalesData policy retentionsoftdelete = 365d\n`);\n```\nThis method will create a `KustoScript` resource that encapsulates the command, ensuring it is executed against the\ndatabase, and is tracked as part of the resource management within Azure.",
|
|
9065
|
+
"summary": "- The KQL script or control command to be executed. This should be a valid KQL command string."
|
|
9066
|
+
},
|
|
8669
9067
|
"name": "scriptContent",
|
|
8670
9068
|
"type": {
|
|
8671
9069
|
"primitive": "string"
|
|
@@ -8675,21 +9073,30 @@
|
|
|
8675
9073
|
},
|
|
8676
9074
|
{
|
|
8677
9075
|
"docs": {
|
|
8678
|
-
"
|
|
9076
|
+
"remarks": "This method creates a table within the specified Kusto database using a given schema. Tables in Kusto store structured data with\ndefined columns and types, which are crucial for storing and querying large datasets efficiently. The method constructs a Kusto\nData Explorer control command to create the table and then executes this command within the context of the database.",
|
|
9077
|
+
"stability": "stable",
|
|
9078
|
+
"summary": "Adds a new table to an existing Azure Kusto database."
|
|
8679
9079
|
},
|
|
8680
9080
|
"locationInModule": {
|
|
8681
9081
|
"filename": "src/azure-kusto/lib/database.ts",
|
|
8682
|
-
"line":
|
|
9082
|
+
"line": 206
|
|
8683
9083
|
},
|
|
8684
9084
|
"name": "addTable",
|
|
8685
9085
|
"parameters": [
|
|
8686
9086
|
{
|
|
9087
|
+
"docs": {
|
|
9088
|
+
"summary": "- The name of the table to create, which must be unique within the database."
|
|
9089
|
+
},
|
|
8687
9090
|
"name": "tableName",
|
|
8688
9091
|
"type": {
|
|
8689
9092
|
"primitive": "string"
|
|
8690
9093
|
}
|
|
8691
9094
|
},
|
|
8692
9095
|
{
|
|
9096
|
+
"docs": {
|
|
9097
|
+
"remarks": "Example usage:\n```typescript\nmyDatabase.addTable('SalesData', [\n{ columnName: 'TransactionId', columnType: 'int' },\n{ columnName: 'TransactionDate', columnType: 'datetime' },\n{ columnName: 'Amount', columnType: 'real' }\n]);\n```\nThis method constructs the command to create the table and applies it directly within the Kusto database,\nensuring the table is ready for data ingestion and querying.",
|
|
9098
|
+
"summary": "- An array of schema properties defining the columns of the table, including column names and their data types."
|
|
9099
|
+
},
|
|
8693
9100
|
"name": "tableSchema",
|
|
8694
9101
|
"type": {
|
|
8695
9102
|
"collection": {
|
|
@@ -9417,26 +9824,38 @@
|
|
|
9417
9824
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_loganalytics.Workspace",
|
|
9418
9825
|
"initializer": {
|
|
9419
9826
|
"docs": {
|
|
9420
|
-
"
|
|
9827
|
+
"remarks": "This class is responsible for the creation and configuration of a Log Analytics Workspace in Azure. A Log Analytics Workspace\nis a unique environment for Azure Monitor data, where data is collected, aggregated, and serves as the administrative boundary.\nWithin a workspace, data is collected from various sources and is used for analysis, visualization, and alerting. Configurations\ncan include data export rules, saved queries, and custom functions to enhance data analytics capabilities.",
|
|
9828
|
+
"stability": "stable",
|
|
9829
|
+
"summary": "Represents an Azure Log Analytics Workspace."
|
|
9421
9830
|
},
|
|
9422
9831
|
"locationInModule": {
|
|
9423
9832
|
"filename": "src/azure-loganalytics/lib/workspace.ts",
|
|
9424
|
-
"line":
|
|
9833
|
+
"line": 180
|
|
9425
9834
|
},
|
|
9426
9835
|
"parameters": [
|
|
9427
9836
|
{
|
|
9837
|
+
"docs": {
|
|
9838
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
9839
|
+
},
|
|
9428
9840
|
"name": "scope",
|
|
9429
9841
|
"type": {
|
|
9430
9842
|
"fqn": "constructs.Construct"
|
|
9431
9843
|
}
|
|
9432
9844
|
},
|
|
9433
9845
|
{
|
|
9846
|
+
"docs": {
|
|
9847
|
+
"summary": "- The unique identifier for this instance of the Log Analytics workspace."
|
|
9848
|
+
},
|
|
9434
9849
|
"name": "id",
|
|
9435
9850
|
"type": {
|
|
9436
9851
|
"primitive": "string"
|
|
9437
9852
|
}
|
|
9438
9853
|
},
|
|
9439
9854
|
{
|
|
9855
|
+
"docs": {
|
|
9856
|
+
"remarks": "These include:\n - `location`: The Azure region where the workspace will be deployed.\n - `name`: The name of the workspace, which must be globally unique.\n - `resourceGroup`: The Azure Resource Group under which the workspace is deployed.\n - `sku`: Optional. The SKU of the workspace, affecting pricing and features.\n - `retention`: Optional. The number of days data will be retained in the workspace.\n - `tags`: Optional. Tags to assign to the workspace for organizational purposes.\n - `dataExport`: Optional. Configurations for exporting data to other Azure resources.\n - `functions`: Optional. Custom functions defined within the workspace for query operations.\n - `queries`: Optional. Saved queries that can be used for data analysis or visualizations.\n\nExample usage:\n```typescript\nnew Workspace(this, 'MyLogAnalyticsWorkspace', {\nlocation: 'East US',\nname: 'myWorkspace',\nresourceGroup: myResourceGroup,\nsku: 'PerGB2018',\nretention: 60,\ntags: { department: 'IT' },\nfunctions: [{\nname: 'ErrorCount',\ndisplayName: 'Error Count',\nquery: 'AzureActivity | summarize count() by bin(timestamp, 1h), type',\nfunctionAlias: 'error_count',\nfunctionParameters: 'timestamp, type'\n}],\nqueries: [{\nname: 'HighCPUUsage',\ncategory: 'Performance',\ndisplayName: 'High CPU Usage',\nquery: 'Perf | where CounterName == \"% Processor Time\" and CounterValue > 80'\n}]\n});\n```\nThis class sets up the workspace and applies configurations, providing a centralized environment for monitoring and analytics.",
|
|
9857
|
+
"summary": "- The properties required to configure the Log Analytics workspace, as defined in the WorkspaceProps interface."
|
|
9858
|
+
},
|
|
9440
9859
|
"name": "props",
|
|
9441
9860
|
"type": {
|
|
9442
9861
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_loganalytics.WorkspaceProps"
|
|
@@ -10026,36 +10445,28 @@
|
|
|
10026
10445
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_metricalert.MetricAlert",
|
|
10027
10446
|
"initializer": {
|
|
10028
10447
|
"docs": {
|
|
10448
|
+
"remarks": "This class encapsulates the configuration and management of a Metric Alert, allowing users to define alert rules based on the metrics from their Azure resources. Metric Alerts can help in proactively managing the health, performance, and availability of Azure services.\n\nProperties:\n- `name`: The name of the Metric Alert, which must be unique within the resource group.\n- `description`: Optional. A description of what the Metric Alert monitors and potential impact or remediation.\n- `enabled`: Indicates whether the alert rule is enabled. Disabled rules will not fire.\n- `autoMitigate`: Specifies whether the alert should attempt auto-mitigation actions when triggered.\n- `frequency`: The frequency of evaluation for the alert rule, determining how often the rule is checked.\n- `severity`: The severity level assigned to the alert. This helps in categorizing the urgency of the alert.\n- `targetResourceType`: Specifies the type of Azure resource the alert rule applies to, necessary for scoping the alert.\n- `targetResourceLocation`: Specifies the location of the target resource, required when the alert rule covers resources in multiple locations.\n- `windowSize`: The period over which data is collected for analysis, which must be greater than the frequency of evaluation.\n- `tags`: User-defined tags to help organize and identify resources within Azure.\n- `criteria`: The conditions that trigger the alert. This can be static or dynamic, based on the behavior of the monitored metric over time.\n- `dynamicCriteria`: Advanced configurations for criteria that dynamically adjust thresholds based on historical data.\n- `scopes`: The specific resources that the Metric Alert is scoped to monitor.\n- `resourceGroup`: The Azure Resource Group in which this Metric Alert is defined.\n\nExample usage:\n```typescript\nconst cpuAlertProps: IMetricAlertProps = {\n name: 'High CPU Usage Alert',\n resourceGroup: resourceGroupInstance,\n scopes: [vm.id],\n criteria: [\n {\n metricName: 'Percentage CPU',\n operator: 'GreaterThan',\n threshold: 80,\n aggregation: 'Average'\n }\n ],\n frequency: 'PT1M',\n windowSize: 'PT5M',\n severity: 3,\n enabled: true\n};\n\nconst cpuAlert = new MetricAlert(this, 'cpuUsageAlert', cpuAlertProps);\n```\n\nThis configuration defines a Metric Alert that monitors CPU usage across specified virtual machines, triggering an alert if the CPU usage exceeds 80% over a 5-minute window, evaluated every minute.",
|
|
10029
10449
|
"stability": "stable",
|
|
10030
|
-
"summary": "
|
|
10450
|
+
"summary": "Represents a Metric Alert in Azure Monitor, which is used to automatically monitor metrics across Azure services and trigger actions when certain conditions are met."
|
|
10031
10451
|
},
|
|
10032
10452
|
"locationInModule": {
|
|
10033
10453
|
"filename": "src/azure-metricalert/lib/metric-alert.ts",
|
|
10034
|
-
"line":
|
|
10454
|
+
"line": 57
|
|
10035
10455
|
},
|
|
10036
10456
|
"parameters": [
|
|
10037
10457
|
{
|
|
10038
|
-
"docs": {
|
|
10039
|
-
"summary": "- The scope in which this construct is defined."
|
|
10040
|
-
},
|
|
10041
10458
|
"name": "scope",
|
|
10042
10459
|
"type": {
|
|
10043
10460
|
"fqn": "constructs.Construct"
|
|
10044
10461
|
}
|
|
10045
10462
|
},
|
|
10046
10463
|
{
|
|
10047
|
-
"docs": {
|
|
10048
|
-
"summary": "- The ID of this construct."
|
|
10049
|
-
},
|
|
10050
10464
|
"name": "id",
|
|
10051
10465
|
"type": {
|
|
10052
10466
|
"primitive": "string"
|
|
10053
10467
|
}
|
|
10054
10468
|
},
|
|
10055
10469
|
{
|
|
10056
|
-
"docs": {
|
|
10057
|
-
"summary": "- The properties required for Metric Alert."
|
|
10058
|
-
},
|
|
10059
10470
|
"name": "props",
|
|
10060
10471
|
"type": {
|
|
10061
10472
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_metricalert.IMetricAlertProps"
|
|
@@ -11598,26 +12009,38 @@
|
|
|
11598
12009
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_networksecuritygroup.SecurityGroup",
|
|
11599
12010
|
"initializer": {
|
|
11600
12011
|
"docs": {
|
|
11601
|
-
"
|
|
12012
|
+
"remarks": "This class is responsible for the creation and management of an Azure Network Security Group, which acts as a virtual firewall\nfor virtual network resources. A Network Security Group contains a list of security rules that allow or deny network traffic\nto resources connected to Azure Virtual Networks (VNet). Each rule specifies a combination of source and destination, port,\nand protocol, and an action (allow or deny) based on those combinations. This class allows for detailed configuration of these\nrules to enforce security policies for inbound and outbound network traffic.",
|
|
12013
|
+
"stability": "stable",
|
|
12014
|
+
"summary": "Represents an Azure Network Security Group (NSG)."
|
|
11602
12015
|
},
|
|
11603
12016
|
"locationInModule": {
|
|
11604
12017
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11605
|
-
"line":
|
|
12018
|
+
"line": 130
|
|
11606
12019
|
},
|
|
11607
12020
|
"parameters": [
|
|
11608
12021
|
{
|
|
12022
|
+
"docs": {
|
|
12023
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
12024
|
+
},
|
|
11609
12025
|
"name": "scope",
|
|
11610
12026
|
"type": {
|
|
11611
12027
|
"fqn": "constructs.Construct"
|
|
11612
12028
|
}
|
|
11613
12029
|
},
|
|
11614
12030
|
{
|
|
12031
|
+
"docs": {
|
|
12032
|
+
"summary": "- The unique identifier for this instance of the security group."
|
|
12033
|
+
},
|
|
11615
12034
|
"name": "id",
|
|
11616
12035
|
"type": {
|
|
11617
12036
|
"primitive": "string"
|
|
11618
12037
|
}
|
|
11619
12038
|
},
|
|
11620
12039
|
{
|
|
12040
|
+
"docs": {
|
|
12041
|
+
"remarks": "These include:\n - `resourceGroup`: The Azure Resource Group under which the NSG will be deployed.\n - `location`: The Azure region where the NSG will be created.\n - `name`: The name of the NSG, which must be unique within the resource group.\n - `rules`: A list of rules that define the security policies for traffic control.\n\nExample usage:\n```typescript\nnew SecurityGroup(this, 'MySecurityGroup', {\nresourceGroup: myResourceGroup,\nlocation: 'East US',\nname: 'myNsg',\nrules: [{\nname: 'AllowSSH',\npriority: 100,\ndirection: 'Inbound',\naccess: 'Allow',\nprotocol: 'Tcp',\nsourcePortRange: '*',\ndestinationPortRange: '22',\nsourceAddressPrefix: '*',\ndestinationAddressPrefix: '*'\n}]\n});\n```\nThis class initializes a Network Security Group with specified rules, handling network security management tasks efficiently.",
|
|
12042
|
+
"summary": "- The properties required to configure the Network Security Group, as defined in the SecurityGroupProps interface."
|
|
12043
|
+
},
|
|
11621
12044
|
"name": "props",
|
|
11622
12045
|
"type": {
|
|
11623
12046
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_networksecuritygroup.SecurityGroupProps"
|
|
@@ -11633,15 +12056,21 @@
|
|
|
11633
12056
|
"methods": [
|
|
11634
12057
|
{
|
|
11635
12058
|
"docs": {
|
|
11636
|
-
"
|
|
12059
|
+
"remarks": "This method attaches the security group to a network interface, applying the security group's rules to the network interface.\nThis allows for fine-grained control of network traffic to and from the specific network interface.",
|
|
12060
|
+
"stability": "stable",
|
|
12061
|
+
"summary": "Associates this Network Security Group with a specified network interface."
|
|
11637
12062
|
},
|
|
11638
12063
|
"locationInModule": {
|
|
11639
12064
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11640
|
-
"line":
|
|
12065
|
+
"line": 203
|
|
11641
12066
|
},
|
|
11642
12067
|
"name": "associateToNetworkInterface",
|
|
11643
12068
|
"parameters": [
|
|
11644
12069
|
{
|
|
12070
|
+
"docs": {
|
|
12071
|
+
"remarks": "Example usage:\n```typescript\nconst myNetworkInterface = { id: 'nic-456', name: 'NetworkInterfaceA' };\nmySecurityGroup.associateToNetworkInterface(myNetworkInterface);\n```\nThis operation ensures that the security rules defined in the network security group are applied directly to the specified\nnetwork interface, controlling access in a more targeted manner.",
|
|
12072
|
+
"summary": "- The network interface object to which this network security group will be associated."
|
|
12073
|
+
},
|
|
11645
12074
|
"name": "networkInterface",
|
|
11646
12075
|
"type": {
|
|
11647
12076
|
"fqn": "@cdktf/provider-azurerm.networkInterface.NetworkInterface"
|
|
@@ -11651,15 +12080,21 @@
|
|
|
11651
12080
|
},
|
|
11652
12081
|
{
|
|
11653
12082
|
"docs": {
|
|
11654
|
-
"
|
|
12083
|
+
"remarks": "This method facilitates the attachment of the security group to a subnet, applying the security group's rules to all\nresources within the subnet. This is crucial for managing network access and security policies at the subnet level.",
|
|
12084
|
+
"stability": "stable",
|
|
12085
|
+
"summary": "Associates this Network Security Group with a specified subnet."
|
|
11655
12086
|
},
|
|
11656
12087
|
"locationInModule": {
|
|
11657
12088
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11658
|
-
"line":
|
|
12089
|
+
"line": 180
|
|
11659
12090
|
},
|
|
11660
12091
|
"name": "associateToSubnet",
|
|
11661
12092
|
"parameters": [
|
|
11662
12093
|
{
|
|
12094
|
+
"docs": {
|
|
12095
|
+
"remarks": "Example usage:\n```typescript\nconst mySubnet = { id: 'subnet-123', name: 'SubnetA' };\nmySecurityGroup.associateToSubnet(mySubnet);\n```\nThis operation ensures that the security rules defined in the network security group are enforced on all network interfaces\nattached to the specified subnet.",
|
|
12096
|
+
"summary": "- The subnet object to which this network security group will be associated."
|
|
12097
|
+
},
|
|
11663
12098
|
"name": "subnet",
|
|
11664
12099
|
"type": {
|
|
11665
12100
|
"fqn": "@cdktf/provider-azurerm.subnet.Subnet"
|
|
@@ -11739,26 +12174,38 @@
|
|
|
11739
12174
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_networksecuritygroup.SecurityGroupAssociations",
|
|
11740
12175
|
"initializer": {
|
|
11741
12176
|
"docs": {
|
|
11742
|
-
"
|
|
12177
|
+
"remarks": "This class provides the functionality to associate a network security group with either subnets or network interfaces\nwithin the Azure environment. By managing these associations, it helps enforce security rules at both the subnet level\nand the network interface level, enhancing security configurations and compliance.",
|
|
12178
|
+
"stability": "stable",
|
|
12179
|
+
"summary": "Manages the associations of Azure Network Security Groups with subnets and network interfaces."
|
|
11743
12180
|
},
|
|
11744
12181
|
"locationInModule": {
|
|
11745
12182
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11746
|
-
"line":
|
|
12183
|
+
"line": 256
|
|
11747
12184
|
},
|
|
11748
12185
|
"parameters": [
|
|
11749
12186
|
{
|
|
12187
|
+
"docs": {
|
|
12188
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
12189
|
+
},
|
|
11750
12190
|
"name": "scope",
|
|
11751
12191
|
"type": {
|
|
11752
12192
|
"fqn": "constructs.Construct"
|
|
11753
12193
|
}
|
|
11754
12194
|
},
|
|
11755
12195
|
{
|
|
12196
|
+
"docs": {
|
|
12197
|
+
"summary": "- The unique identifier for the association instance."
|
|
12198
|
+
},
|
|
11756
12199
|
"name": "id",
|
|
11757
12200
|
"type": {
|
|
11758
12201
|
"primitive": "string"
|
|
11759
12202
|
}
|
|
11760
12203
|
},
|
|
11761
12204
|
{
|
|
12205
|
+
"docs": {
|
|
12206
|
+
"remarks": "Includes the network security group ID and optionally a subnet ID or network interface ID.\n\nExample usage:\n```typescript\nnew SecurityGroupAssociations(this, 'MyAssociations', {\nnetworkSecurityGroupId: 'nsg-123',\nsubnetId: 'subnet-123',\nnetworkInterfaceId: 'nic-456',\n});\n```\nDepending on the properties provided, this class will create the appropriate associations to apply the network security group\nto the specified subnet or network interface.",
|
|
12207
|
+
"summary": "- The properties for the association."
|
|
12208
|
+
},
|
|
11762
12209
|
"name": "props",
|
|
11763
12210
|
"type": {
|
|
11764
12211
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_networksecuritygroup.SecurityGroupAssociationsProps"
|
|
@@ -11769,7 +12216,7 @@
|
|
|
11769
12216
|
"kind": "class",
|
|
11770
12217
|
"locationInModule": {
|
|
11771
12218
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11772
|
-
"line":
|
|
12219
|
+
"line": 233
|
|
11773
12220
|
},
|
|
11774
12221
|
"name": "SecurityGroupAssociations",
|
|
11775
12222
|
"namespace": "azure_networksecuritygroup",
|
|
@@ -11786,7 +12233,7 @@
|
|
|
11786
12233
|
"kind": "interface",
|
|
11787
12234
|
"locationInModule": {
|
|
11788
12235
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11789
|
-
"line":
|
|
12236
|
+
"line": 214
|
|
11790
12237
|
},
|
|
11791
12238
|
"name": "SecurityGroupAssociationsProps",
|
|
11792
12239
|
"namespace": "azure_networksecuritygroup",
|
|
@@ -11800,7 +12247,7 @@
|
|
|
11800
12247
|
"immutable": true,
|
|
11801
12248
|
"locationInModule": {
|
|
11802
12249
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11803
|
-
"line":
|
|
12250
|
+
"line": 218
|
|
11804
12251
|
},
|
|
11805
12252
|
"name": "networkSecurityGroupId",
|
|
11806
12253
|
"type": {
|
|
@@ -11817,7 +12264,7 @@
|
|
|
11817
12264
|
"immutable": true,
|
|
11818
12265
|
"locationInModule": {
|
|
11819
12266
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11820
|
-
"line":
|
|
12267
|
+
"line": 230
|
|
11821
12268
|
},
|
|
11822
12269
|
"name": "networkInterfaceId",
|
|
11823
12270
|
"optional": true,
|
|
@@ -11835,7 +12282,7 @@
|
|
|
11835
12282
|
"immutable": true,
|
|
11836
12283
|
"locationInModule": {
|
|
11837
12284
|
"filename": "src/azure-networksecuritygroup/lib/securitygroup.ts",
|
|
11838
|
-
"line":
|
|
12285
|
+
"line": 224
|
|
11839
12286
|
},
|
|
11840
12287
|
"name": "subnetId",
|
|
11841
12288
|
"optional": true,
|
|
@@ -12467,17 +12914,18 @@
|
|
|
12467
12914
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_queryrulealert.QueryRuleAlert",
|
|
12468
12915
|
"initializer": {
|
|
12469
12916
|
"docs": {
|
|
12917
|
+
"remarks": "This class is responsible for the creation and management of a Scheduled Query Rule Alert in Azure Monitor.\nScheduled Query Rule Alerts execute specified queries at regular intervals over the data collected in Log Analytics\nWorkspaces or Application Insights, and alert based on the results of these queries. These alerts can be used to monitor\napplication health, infrastructure changes, or compliance with certain conditions.",
|
|
12470
12918
|
"stability": "stable",
|
|
12471
|
-
"summary": "
|
|
12919
|
+
"summary": "Represents an Azure Monitor Scheduled Query Rule Alert."
|
|
12472
12920
|
},
|
|
12473
12921
|
"locationInModule": {
|
|
12474
12922
|
"filename": "src/azure-queryrulealert/lib/query-rule-alert.ts",
|
|
12475
|
-
"line":
|
|
12923
|
+
"line": 183
|
|
12476
12924
|
},
|
|
12477
12925
|
"parameters": [
|
|
12478
12926
|
{
|
|
12479
12927
|
"docs": {
|
|
12480
|
-
"summary": "- The scope in which this construct
|
|
12928
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
12481
12929
|
},
|
|
12482
12930
|
"name": "scope",
|
|
12483
12931
|
"type": {
|
|
@@ -12486,7 +12934,7 @@
|
|
|
12486
12934
|
},
|
|
12487
12935
|
{
|
|
12488
12936
|
"docs": {
|
|
12489
|
-
"summary": "- The
|
|
12937
|
+
"summary": "- The unique identifier for this instance of the Scheduled Query Rule Alert."
|
|
12490
12938
|
},
|
|
12491
12939
|
"name": "id",
|
|
12492
12940
|
"type": {
|
|
@@ -12495,7 +12943,8 @@
|
|
|
12495
12943
|
},
|
|
12496
12944
|
{
|
|
12497
12945
|
"docs": {
|
|
12498
|
-
"
|
|
12946
|
+
"remarks": "These include:\n - `name`: The name of the Scheduled Query Rule.\n - `resourceGroup`: The Azure Resource Group under which the alert will be created.\n - `location`: The Azure region where the alert will be deployed.\n - `criteriaQuery`: The query to execute. The results of this query determine whether an alert should be triggered.\n - `evaluationFrequency`: How often the query should be run.\n - `windowDuration`: The time period over which data is collected for each execution of the query.\n - `severity`: The severity of the alert.\n - `actionActionGroupId`: The action group to invoke when the alert criteria are met.\n - `enabled`: Indicates whether the alert rule is enabled.\n\nExample usage:\n```typescript\nnew QueryRuleAlert(this, 'MyAlertRule', {\nname: 'HighErrorRateAlert',\nresourceGroup: myResourceGroup,\nlocation: 'West US 2',\ncriteriaQuery: 'Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m)',\nevaluationFrequency: 'PT5M',\nwindowDuration: 'PT1H',\nseverity: 3,\nactionActionGroupId: ['/subscriptions/sub-id/resourceGroups/rg/providers/microsoft.insights/actionGroups/myActionGroup'],\nenabled: true\n});\n```\nThis class sets up the alert rule and ensures it is ready to trigger actions based on the specified criteria and schedule.",
|
|
12947
|
+
"summary": "- The properties required to configure the Scheduled Query Rule Alert, as defined in the AzureQueryRuleAlertProps interface."
|
|
12499
12948
|
},
|
|
12500
12949
|
"name": "props",
|
|
12501
12950
|
"type": {
|
|
@@ -12564,26 +13013,38 @@
|
|
|
12564
13013
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_resourcegroup.Group",
|
|
12565
13014
|
"initializer": {
|
|
12566
13015
|
"docs": {
|
|
12567
|
-
"
|
|
13016
|
+
"remarks": "This class is responsible for the creation and management of an Azure Resource Group, which is a container that holds\nrelated resources for an Azure solution. A resource group includes those resources that you want to manage as a group.\nYou decide how to allocate resources to resource groups based on what makes the most sense for your organization.",
|
|
13017
|
+
"stability": "stable",
|
|
13018
|
+
"summary": "Represents an Azure Resource Group."
|
|
12568
13019
|
},
|
|
12569
13020
|
"locationInModule": {
|
|
12570
13021
|
"filename": "src/azure-resourcegroup/lib/resource-group.ts",
|
|
12571
|
-
"line":
|
|
13022
|
+
"line": 69
|
|
12572
13023
|
},
|
|
12573
13024
|
"parameters": [
|
|
12574
13025
|
{
|
|
13026
|
+
"docs": {
|
|
13027
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
13028
|
+
},
|
|
12575
13029
|
"name": "scope",
|
|
12576
13030
|
"type": {
|
|
12577
13031
|
"fqn": "constructs.Construct"
|
|
12578
13032
|
}
|
|
12579
13033
|
},
|
|
12580
13034
|
{
|
|
13035
|
+
"docs": {
|
|
13036
|
+
"summary": "- The unique identifier for this instance of the Resource Group."
|
|
13037
|
+
},
|
|
12581
13038
|
"name": "id",
|
|
12582
13039
|
"type": {
|
|
12583
13040
|
"primitive": "string"
|
|
12584
13041
|
}
|
|
12585
13042
|
},
|
|
12586
13043
|
{
|
|
13044
|
+
"docs": {
|
|
13045
|
+
"remarks": "These can include:\n - `location`: The Azure region where the Resource Group will be created.\n - `name`: The name of the Resource Group, which must be unique within your Azure subscription.\n - `tags`: A dictionary of tags to apply to the Resource Group for organizational, billing, or other purposes.\n - `ignoreChanges`: A list of properties which should be ignored if changes are made after initial deployment,\n useful in certain scenarios where properties are externally managed or should not trigger updates.\n\nExample usage:\n```typescript\nnew Group(this, 'MyResourceGroup', {\nlocation: 'East US',\nname: 'ApplicationResources',\ntags: {\nenvironment: 'production'\n}\n});\n```\nThis class sets up the resource group and applies any specified configurations, making it ready to hold other Azure resources.",
|
|
13046
|
+
"summary": "- Optional properties for configuring the Resource Group."
|
|
13047
|
+
},
|
|
12587
13048
|
"name": "props",
|
|
12588
13049
|
"optional": true,
|
|
12589
13050
|
"type": {
|
|
@@ -12813,24 +13274,23 @@
|
|
|
12813
13274
|
"assembly": "@microsoft/terraform-cdk-constructs",
|
|
12814
13275
|
"base": "@microsoft/terraform-cdk-constructs.core_azure.AzureResourceWithAlert",
|
|
12815
13276
|
"docs": {
|
|
12816
|
-
"
|
|
12817
|
-
"stability": "stable",
|
|
12818
|
-
"summary": "Represents an Azure Storage Account within a Terraform deployment."
|
|
13277
|
+
"stability": "stable"
|
|
12819
13278
|
},
|
|
12820
13279
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_storageaccount.Account",
|
|
12821
13280
|
"initializer": {
|
|
12822
13281
|
"docs": {
|
|
13282
|
+
"remarks": "This class is responsible for the creation and management of an Azure Storage Account, which is a scalable and secure service\nfor storing large amounts of unstructured data that can be accessed from anywhere in the world over HTTP or HTTPS. Common uses\nof the Azure Storage Account include storing of blobs (objects), file shares, tables, and queues. This class provides methods\nto manage storage resources, configure network rules, and integrate with Azure Active Directory for secure access management.",
|
|
12823
13283
|
"stability": "stable",
|
|
12824
|
-
"summary": "
|
|
13284
|
+
"summary": "Represents an Azure Storage Account within a Terraform deployment."
|
|
12825
13285
|
},
|
|
12826
13286
|
"locationInModule": {
|
|
12827
13287
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
12828
|
-
"line":
|
|
13288
|
+
"line": 166
|
|
12829
13289
|
},
|
|
12830
13290
|
"parameters": [
|
|
12831
13291
|
{
|
|
12832
13292
|
"docs": {
|
|
12833
|
-
"summary": "The scope in which to define this construct."
|
|
13293
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
12834
13294
|
},
|
|
12835
13295
|
"name": "scope",
|
|
12836
13296
|
"type": {
|
|
@@ -12839,7 +13299,7 @@
|
|
|
12839
13299
|
},
|
|
12840
13300
|
{
|
|
12841
13301
|
"docs": {
|
|
12842
|
-
"summary": "The
|
|
13302
|
+
"summary": "- The unique identifier for this instance of the storage account."
|
|
12843
13303
|
},
|
|
12844
13304
|
"name": "id",
|
|
12845
13305
|
"type": {
|
|
@@ -12848,7 +13308,8 @@
|
|
|
12848
13308
|
},
|
|
12849
13309
|
{
|
|
12850
13310
|
"docs": {
|
|
12851
|
-
"
|
|
13311
|
+
"remarks": "These include:\n - `name`: The name of the storage account, which must be unique within the Azure region.\n - `location`: The Azure region where the storage account will be created.\n - `resourceGroup`: The Azure Resource Group under which the storage account will be deployed.\n - `accountReplicationType`: The type of data replication to ensure data durability and availability.\n - `accountTier`: The performance tier that affects the type of hardware used for the storage account.\n - `tags`: A dictionary of tags to apply to the storage account for organizational purposes.\n\nExample usage:\n```typescript\nconst storageAccount = new Account(this, 'MyStorageAccount', {\nlocation: 'East US',\nname: 'myStorageAccount',\nresourceGroup: myResourceGroup,\naccountReplicationType: 'LRS',\naccountTier: 'Standard',\nenableHttpsTrafficOnly: true,\ntags: {\nenvironment: 'production'\n}\n});\n```\nThis class sets up the storage account with the specified configurations, handles resource allocation, and applies security\nsettings based on the properties provided.",
|
|
13312
|
+
"summary": "- The properties required to configure the Azure Storage Account, as defined in the AccountProps interface."
|
|
12852
13313
|
},
|
|
12853
13314
|
"name": "props",
|
|
12854
13315
|
"type": {
|
|
@@ -12860,26 +13321,27 @@
|
|
|
12860
13321
|
"kind": "class",
|
|
12861
13322
|
"locationInModule": {
|
|
12862
13323
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
12863
|
-
"line":
|
|
13324
|
+
"line": 119
|
|
12864
13325
|
},
|
|
12865
13326
|
"methods": [
|
|
12866
13327
|
{
|
|
12867
13328
|
"docs": {
|
|
12868
13329
|
"custom": {
|
|
12869
|
-
"throws": "Error if a container with the same name already exists.\n\nExample usage:\n```typescript\nconst container = storageAccount.addContainer('myContainer', 'private');\n```"
|
|
13330
|
+
"throws": "Error if a container with the same name already exists within the storage account.\n\nThis method creates a new container within the Azure storage account, allowing for the specification of access\nlevel and metadata. If the container already exists, it throws an error to prevent duplication.\n\nExample usage:\n```typescript\nconst container = storageAccount.addContainer('myContainer', 'private', { owner: 'IT' });\n```"
|
|
12870
13331
|
},
|
|
12871
|
-
"returns": "The created
|
|
13332
|
+
"returns": "The created Container instance.",
|
|
12872
13333
|
"stability": "stable",
|
|
12873
13334
|
"summary": "Adds a new container to the storage account."
|
|
12874
13335
|
},
|
|
12875
13336
|
"locationInModule": {
|
|
12876
13337
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
12877
|
-
"line":
|
|
13338
|
+
"line": 221
|
|
12878
13339
|
},
|
|
12879
13340
|
"name": "addContainer",
|
|
12880
13341
|
"parameters": [
|
|
12881
13342
|
{
|
|
12882
13343
|
"docs": {
|
|
13344
|
+
"remarks": "It must be unique within the storage account.",
|
|
12883
13345
|
"summary": "The name of the container."
|
|
12884
13346
|
},
|
|
12885
13347
|
"name": "name",
|
|
@@ -12889,7 +13351,8 @@
|
|
|
12889
13351
|
},
|
|
12890
13352
|
{
|
|
12891
13353
|
"docs": {
|
|
12892
|
-
"
|
|
13354
|
+
"remarks": "Defaults to 'private'.",
|
|
13355
|
+
"summary": "The level of public access to the container."
|
|
12893
13356
|
},
|
|
12894
13357
|
"name": "containerAccessType",
|
|
12895
13358
|
"optional": true,
|
|
@@ -12899,7 +13362,7 @@
|
|
|
12899
13362
|
},
|
|
12900
13363
|
{
|
|
12901
13364
|
"docs": {
|
|
12902
|
-
"summary": "
|
|
13365
|
+
"summary": "Optional metadata for the container as key-value pairs."
|
|
12903
13366
|
},
|
|
12904
13367
|
"name": "metadata",
|
|
12905
13368
|
"optional": true,
|
|
@@ -12922,20 +13385,21 @@
|
|
|
12922
13385
|
{
|
|
12923
13386
|
"docs": {
|
|
12924
13387
|
"custom": {
|
|
12925
|
-
"throws": "Error if a share with the same name already exists.\n\nExample usage:\n```typescript\nconst fileShare = storageAccount.
|
|
13388
|
+
"throws": "Error if a file share with the same name already exists.\n\nThis method facilitates the addition of a file share to the storage account, with optional settings for\ncapacity (quota) and data access frequency (access tier). If a file share with the same name exists, an error is thrown.\n\nExample usage:\n```typescript\nconst fileShare = storageAccount.addFileShare('myFileShare', { quota: 1024, accessTier: 'Hot' });\n```"
|
|
12926
13389
|
},
|
|
12927
|
-
"returns": "The created
|
|
13390
|
+
"returns": "The created FileShare instance.",
|
|
12928
13391
|
"stability": "stable",
|
|
12929
13392
|
"summary": "Adds a new file share to the storage account."
|
|
12930
13393
|
},
|
|
12931
13394
|
"locationInModule": {
|
|
12932
13395
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
12933
|
-
"line":
|
|
13396
|
+
"line": 257
|
|
12934
13397
|
},
|
|
12935
13398
|
"name": "addFileShare",
|
|
12936
13399
|
"parameters": [
|
|
12937
13400
|
{
|
|
12938
13401
|
"docs": {
|
|
13402
|
+
"remarks": "Must be unique within the storage account.",
|
|
12939
13403
|
"summary": "The name of the file share."
|
|
12940
13404
|
},
|
|
12941
13405
|
"name": "name",
|
|
@@ -12945,7 +13409,7 @@
|
|
|
12945
13409
|
},
|
|
12946
13410
|
{
|
|
12947
13411
|
"docs": {
|
|
12948
|
-
"summary": "Optional properties for the file share
|
|
13412
|
+
"summary": "Optional properties for configuring the file share, such as quota and access tier."
|
|
12949
13413
|
},
|
|
12950
13414
|
"name": "props",
|
|
12951
13415
|
"optional": true,
|
|
@@ -12962,19 +13426,19 @@
|
|
|
12962
13426
|
},
|
|
12963
13427
|
{
|
|
12964
13428
|
"docs": {
|
|
12965
|
-
"returns": "The configured
|
|
13429
|
+
"returns": "The configured network rules.\n\nThis method configures network rules for the storage account, specifying which IPs and virtual networks can access\nthe storage resources. It allows detailed control over data security and access management.\n\nExample usage:\n```typescript\nstorageAccount.addNetworkRules({\nbypass: ['AzureServices'],\ndefaultAction: 'Deny',\nipRules: ['1.2.3.4/32'],\nvirtualNetworkSubnetIds: ['subnetId'],\n});\n```",
|
|
12966
13430
|
"stability": "stable",
|
|
12967
|
-
"summary": "Adds network rules to the storage account."
|
|
13431
|
+
"summary": "Adds network rules to the storage account to control access based on IP and virtual network settings."
|
|
12968
13432
|
},
|
|
12969
13433
|
"locationInModule": {
|
|
12970
13434
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
12971
|
-
"line":
|
|
13435
|
+
"line": 353
|
|
12972
13436
|
},
|
|
12973
13437
|
"name": "addNetworkRules",
|
|
12974
13438
|
"parameters": [
|
|
12975
13439
|
{
|
|
12976
13440
|
"docs": {
|
|
12977
|
-
"summary": "Configuration properties for the network rules."
|
|
13441
|
+
"summary": "Configuration properties for the network rules, including allowed IPs and virtual network subnet IDs."
|
|
12978
13442
|
},
|
|
12979
13443
|
"name": "props",
|
|
12980
13444
|
"type": {
|
|
@@ -12990,18 +13454,19 @@
|
|
|
12990
13454
|
},
|
|
12991
13455
|
{
|
|
12992
13456
|
"docs": {
|
|
12993
|
-
"returns": "The created
|
|
13457
|
+
"returns": "The created Queue instance.\n\nThis method creates a new queue in the storage account, with optional metadata. It is useful for message queuing\nin applications, enabling asynchronous task processing and inter-service communication.\n\nExample usage:\n```typescript\nconst queue = storageAccount.addQueue('myQueue', { priority: 'high' });\n```",
|
|
12994
13458
|
"stability": "stable",
|
|
12995
13459
|
"summary": "Adds a new queue to the storage account."
|
|
12996
13460
|
},
|
|
12997
13461
|
"locationInModule": {
|
|
12998
13462
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
12999
|
-
"line":
|
|
13463
|
+
"line": 326
|
|
13000
13464
|
},
|
|
13001
13465
|
"name": "addQueue",
|
|
13002
13466
|
"parameters": [
|
|
13003
13467
|
{
|
|
13004
13468
|
"docs": {
|
|
13469
|
+
"remarks": "Must be unique within the storage account.",
|
|
13005
13470
|
"summary": "The name of the queue."
|
|
13006
13471
|
},
|
|
13007
13472
|
"name": "name",
|
|
@@ -13011,7 +13476,7 @@
|
|
|
13011
13476
|
},
|
|
13012
13477
|
{
|
|
13013
13478
|
"docs": {
|
|
13014
|
-
"summary": "Optional metadata for the queue."
|
|
13479
|
+
"summary": "Optional metadata for the queue as key-value pairs."
|
|
13015
13480
|
},
|
|
13016
13481
|
"name": "metadata",
|
|
13017
13482
|
"optional": true,
|
|
@@ -13034,20 +13499,21 @@
|
|
|
13034
13499
|
{
|
|
13035
13500
|
"docs": {
|
|
13036
13501
|
"custom": {
|
|
13037
|
-
"throws": "Error if a table with the same name already exists.\n\nExample usage:\n```typescript\nconst table = storageAccount.addTable('myTable');\n```"
|
|
13502
|
+
"throws": "Error if a table with the same name already exists.\n\nThis method creates a new table within the storage account, optionally allowing for access control configurations.\nIt throws an error if a table with the same name already exists, ensuring uniqueness within the account.\n\nExample usage:\n```typescript\nconst table = storageAccount.addTable('myTable', [{ id: 'policy1', type: 'read' }]);\n```"
|
|
13038
13503
|
},
|
|
13039
|
-
"returns": "The created
|
|
13504
|
+
"returns": "The created Table instance.",
|
|
13040
13505
|
"stability": "stable",
|
|
13041
13506
|
"summary": "Adds a new table to the storage account."
|
|
13042
13507
|
},
|
|
13043
13508
|
"locationInModule": {
|
|
13044
13509
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13045
|
-
"line":
|
|
13510
|
+
"line": 296
|
|
13046
13511
|
},
|
|
13047
13512
|
"name": "addTable",
|
|
13048
13513
|
"parameters": [
|
|
13049
13514
|
{
|
|
13050
13515
|
"docs": {
|
|
13516
|
+
"remarks": "Must be unique within the storage account.",
|
|
13051
13517
|
"summary": "The name of the table."
|
|
13052
13518
|
},
|
|
13053
13519
|
"name": "name",
|
|
@@ -13057,7 +13523,7 @@
|
|
|
13057
13523
|
},
|
|
13058
13524
|
{
|
|
13059
13525
|
"docs": {
|
|
13060
|
-
"summary": "Optional access control list for the table."
|
|
13526
|
+
"summary": "Optional access control list for the table, specifying permissions."
|
|
13061
13527
|
},
|
|
13062
13528
|
"name": "acl",
|
|
13063
13529
|
"optional": true,
|
|
@@ -13088,7 +13554,7 @@
|
|
|
13088
13554
|
"immutable": true,
|
|
13089
13555
|
"locationInModule": {
|
|
13090
13556
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13091
|
-
"line":
|
|
13557
|
+
"line": 125
|
|
13092
13558
|
},
|
|
13093
13559
|
"name": "accountKind",
|
|
13094
13560
|
"type": {
|
|
@@ -13102,7 +13568,7 @@
|
|
|
13102
13568
|
"immutable": true,
|
|
13103
13569
|
"locationInModule": {
|
|
13104
13570
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13105
|
-
"line":
|
|
13571
|
+
"line": 126
|
|
13106
13572
|
},
|
|
13107
13573
|
"name": "accountTier",
|
|
13108
13574
|
"type": {
|
|
@@ -13116,7 +13582,7 @@
|
|
|
13116
13582
|
"immutable": true,
|
|
13117
13583
|
"locationInModule": {
|
|
13118
13584
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13119
|
-
"line":
|
|
13585
|
+
"line": 123
|
|
13120
13586
|
},
|
|
13121
13587
|
"name": "location",
|
|
13122
13588
|
"type": {
|
|
@@ -13130,7 +13596,7 @@
|
|
|
13130
13596
|
"immutable": true,
|
|
13131
13597
|
"locationInModule": {
|
|
13132
13598
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13133
|
-
"line":
|
|
13599
|
+
"line": 122
|
|
13134
13600
|
},
|
|
13135
13601
|
"name": "name",
|
|
13136
13602
|
"type": {
|
|
@@ -13144,7 +13610,7 @@
|
|
|
13144
13610
|
"immutable": true,
|
|
13145
13611
|
"locationInModule": {
|
|
13146
13612
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13147
|
-
"line":
|
|
13613
|
+
"line": 120
|
|
13148
13614
|
},
|
|
13149
13615
|
"name": "props",
|
|
13150
13616
|
"type": {
|
|
@@ -13157,7 +13623,7 @@
|
|
|
13157
13623
|
},
|
|
13158
13624
|
"locationInModule": {
|
|
13159
13625
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13160
|
-
"line":
|
|
13626
|
+
"line": 121
|
|
13161
13627
|
},
|
|
13162
13628
|
"name": "id",
|
|
13163
13629
|
"overrides": "@microsoft/terraform-cdk-constructs.core_azure.AzureResource",
|
|
@@ -13171,7 +13637,7 @@
|
|
|
13171
13637
|
},
|
|
13172
13638
|
"locationInModule": {
|
|
13173
13639
|
"filename": "src/azure-storageaccount/lib/account.ts",
|
|
13174
|
-
"line":
|
|
13640
|
+
"line": 124
|
|
13175
13641
|
},
|
|
13176
13642
|
"name": "resourceGroup",
|
|
13177
13643
|
"overrides": "@microsoft/terraform-cdk-constructs.core_azure.AzureResource",
|
|
@@ -13440,26 +13906,38 @@
|
|
|
13440
13906
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_storageaccount.Blob",
|
|
13441
13907
|
"initializer": {
|
|
13442
13908
|
"docs": {
|
|
13443
|
-
"
|
|
13909
|
+
"remarks": "This class is responsible for the creation and management of a blob in an Azure Storage Container. Blobs are unstructured\ndata objects, which can include files like images, documents, videos, or any other file type. The Blob class provides a way\nto manage these files in the cloud, allowing for scalable, durable, and accessible data storage. This class supports various\nblob types such as block blobs for text and binary data, append blobs for log files, and page blobs for large volumes of\nrandom access data.",
|
|
13910
|
+
"stability": "stable",
|
|
13911
|
+
"summary": "Represents a blob within an Azure Storage Container."
|
|
13444
13912
|
},
|
|
13445
13913
|
"locationInModule": {
|
|
13446
13914
|
"filename": "src/azure-storageaccount/lib/container.ts",
|
|
13447
|
-
"line":
|
|
13915
|
+
"line": 160
|
|
13448
13916
|
},
|
|
13449
13917
|
"parameters": [
|
|
13450
13918
|
{
|
|
13919
|
+
"docs": {
|
|
13920
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
13921
|
+
},
|
|
13451
13922
|
"name": "scope",
|
|
13452
13923
|
"type": {
|
|
13453
13924
|
"fqn": "constructs.Construct"
|
|
13454
13925
|
}
|
|
13455
13926
|
},
|
|
13456
13927
|
{
|
|
13928
|
+
"docs": {
|
|
13929
|
+
"summary": "- The unique identifier for this instance of the blob."
|
|
13930
|
+
},
|
|
13457
13931
|
"name": "id",
|
|
13458
13932
|
"type": {
|
|
13459
13933
|
"primitive": "string"
|
|
13460
13934
|
}
|
|
13461
13935
|
},
|
|
13462
13936
|
{
|
|
13937
|
+
"docs": {
|
|
13938
|
+
"remarks": "These properties may include:\n - `name`: The name of the blob, which must be unique within the container.\n - `storageAccountName`: The name of the storage account in which the blob is stored.\n - `storageContainerName`: The name of the storage container in which the blob resides.\n - `type`: The type of the blob (e.g., 'Block', 'Append', 'Page').\n - `source`: The source of the blob's content, which could be a path to a file or a URL.\n - `contentType`: The MIME type of the blob's content, such as 'application/octet-stream' for binary data.\n - `metadata`: A dictionary of strings that represents metadata to associate with the blob.\n - `accessTier`: The data access tier, affecting storage costs and data retrieval speeds.\n - `cacheControl`, `contentEncoding`, `contentDisposition`, `contentMd5`: Optional parameters for controlling the caching behavior,\n encoding, content disposition, and integrity check of the blob.\n\nExample usage:\n```typescript\nconst myBlob = new Blob(this, 'MyBlob', {\nname: 'exampleblob',\nstorageAccountName: 'mystorageaccount',\nstorageContainerName: 'mycontainer',\ntype: 'Block',\nsource: './path/to/file.jpg',\ncontentType: 'image/jpeg',\nmetadata: {\nauthor: 'John Doe'\n}\n});\n```\nThis class initializes a blob with the specified configurations and handles the uploading of content from the specified source.",
|
|
13939
|
+
"summary": "- Configuration properties for the Azure Storage Blob."
|
|
13940
|
+
},
|
|
13463
13941
|
"name": "props",
|
|
13464
13942
|
"type": {
|
|
13465
13943
|
"fqn": "@cdktf/provider-azurerm.storageBlob.StorageBlobConfig"
|
|
@@ -13470,7 +13948,7 @@
|
|
|
13470
13948
|
"kind": "class",
|
|
13471
13949
|
"locationInModule": {
|
|
13472
13950
|
"filename": "src/azure-storageaccount/lib/container.ts",
|
|
13473
|
-
"line":
|
|
13951
|
+
"line": 118
|
|
13474
13952
|
},
|
|
13475
13953
|
"name": "Blob",
|
|
13476
13954
|
"namespace": "azure_storageaccount",
|
|
@@ -13482,7 +13960,7 @@
|
|
|
13482
13960
|
"immutable": true,
|
|
13483
13961
|
"locationInModule": {
|
|
13484
13962
|
"filename": "src/azure-storageaccount/lib/container.ts",
|
|
13485
|
-
"line":
|
|
13963
|
+
"line": 119
|
|
13486
13964
|
},
|
|
13487
13965
|
"name": "name",
|
|
13488
13966
|
"type": {
|
|
@@ -13501,26 +13979,38 @@
|
|
|
13501
13979
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_storageaccount.Container",
|
|
13502
13980
|
"initializer": {
|
|
13503
13981
|
"docs": {
|
|
13504
|
-
"
|
|
13982
|
+
"remarks": "This class is designed for the creation and management of an Azure Storage Container, which serves as a unit of storage\nthat houses data objects, known as blobs. Containers are analogous to directories in a file system, and are used to organize\nsets of blobs within a storage account. This class allows for granular control over blob storage, providing functionalities\nsuch as setting access levels, managing metadata, and implementing security measures like encryption scopes.",
|
|
13983
|
+
"stability": "stable",
|
|
13984
|
+
"summary": "Represents an Azure Storage Container within a specific Azure Storage Account."
|
|
13505
13985
|
},
|
|
13506
13986
|
"locationInModule": {
|
|
13507
13987
|
"filename": "src/azure-storageaccount/lib/container.ts",
|
|
13508
|
-
"line":
|
|
13988
|
+
"line": 55
|
|
13509
13989
|
},
|
|
13510
13990
|
"parameters": [
|
|
13511
13991
|
{
|
|
13992
|
+
"docs": {
|
|
13993
|
+
"summary": "- The scope in which to define this construct, typically a reference to the Cloud Development Kit (CDK) stack."
|
|
13994
|
+
},
|
|
13512
13995
|
"name": "scope",
|
|
13513
13996
|
"type": {
|
|
13514
13997
|
"fqn": "constructs.Construct"
|
|
13515
13998
|
}
|
|
13516
13999
|
},
|
|
13517
14000
|
{
|
|
14001
|
+
"docs": {
|
|
14002
|
+
"summary": "- The unique identifier for this instance of the container."
|
|
14003
|
+
},
|
|
13518
14004
|
"name": "id",
|
|
13519
14005
|
"type": {
|
|
13520
14006
|
"primitive": "string"
|
|
13521
14007
|
}
|
|
13522
14008
|
},
|
|
13523
14009
|
{
|
|
14010
|
+
"docs": {
|
|
14011
|
+
"remarks": "These include:\n - `name`: The name of the storage container, which must be unique within the associated storage account.\n - `storageAccountName`: The name of the storage account where this container is located.\n - `containerAccessType`: Defines the level of public access to the container. Options include 'container',\n 'blob', or 'none', controlling how the blobs within the container can be accessed.\n - `defaultEncryptionScope`: Specifies the default encryption scope for the container, enhancing data security.\n - `encryptionScopeOverrideEnabled`: Allows or prevents overriding the encryption scope on a per-blob basis.\n - `metadata`: Key-value pairs that provide additional information about the container, which can be used for\n organizational, search, or billing purposes.\n - `timeouts`: Specifies custom timeout settings for CRUD operations on the container, providing control over\n operation durations and retries.\n\nExample usage:\n```typescript\nconst storageContainer = new Container(this, 'MyContainer', {\nname: 'mycontainer',\nstorageAccountName: 'mystorageaccount',\ncontainerAccessType: 'blob',\ndefaultEncryptionScope: 'myEncryptionScope',\nencryptionScopeOverrideEnabled: true,\nmetadata: {\ndepartment: 'Finance'\n}\n});\n```\nThis instantiation sets up a storage container with specified properties including access types and metadata. It is ready\nto house blobs and provides methods to manage these blobs effectively.",
|
|
14012
|
+
"summary": "- Configuration properties for the Azure Storage Container, based on the StorageContainerConfig interface."
|
|
14013
|
+
},
|
|
13524
14014
|
"name": "props",
|
|
13525
14015
|
"type": {
|
|
13526
14016
|
"fqn": "@cdktf/provider-azurerm.storageContainer.StorageContainerConfig"
|
|
@@ -13536,19 +14026,20 @@
|
|
|
13536
14026
|
"methods": [
|
|
13537
14027
|
{
|
|
13538
14028
|
"docs": {
|
|
13539
|
-
"
|
|
14029
|
+
"remarks": "This method facilitates the addition of a blob to an Azure Storage Container managed by this class. It handles the creation and\nconfiguration of the blob, including setting its type, source content, and metadata. This is useful for uploading various types\nof unstructured data, such as images, videos, documents, or other binary files, into a cloud-based storage solution.",
|
|
14030
|
+
"returns": "The newly created Blob object, which represents the blob added to the storage container.\n\nExample usage:\n```typescript\nconst storageBlob = storageContainer.addBlob('exampleBlob', './path/to/local/file.txt', {\ntype: 'Block',\ncontentType: 'text/plain',\nmetadata: { customKey: 'customValue' }\n});\n```\nIn this example, a new blob named 'exampleBlob' is added to the storage container. The content of the blob is sourced\nfrom a local file specified by `filePath`. The blob is configured as a 'Block' type with 'text/plain' content type and\ncustom metadata. The method returns the blob instance for further use or reference.",
|
|
13540
14031
|
"stability": "stable",
|
|
13541
|
-
"summary": "Adds a blob to
|
|
14032
|
+
"summary": "Adds a blob to this Azure Storage Container."
|
|
13542
14033
|
},
|
|
13543
14034
|
"locationInModule": {
|
|
13544
14035
|
"filename": "src/azure-storageaccount/lib/container.ts",
|
|
13545
|
-
"line":
|
|
14036
|
+
"line": 103
|
|
13546
14037
|
},
|
|
13547
14038
|
"name": "addBlob",
|
|
13548
14039
|
"parameters": [
|
|
13549
14040
|
{
|
|
13550
14041
|
"docs": {
|
|
13551
|
-
"summary": "The name of the blob to be added."
|
|
14042
|
+
"summary": "- The name of the blob to be added, which will be used as the blob's unique identifier within the container."
|
|
13552
14043
|
},
|
|
13553
14044
|
"name": "blobName",
|
|
13554
14045
|
"type": {
|
|
@@ -13557,7 +14048,8 @@
|
|
|
13557
14048
|
},
|
|
13558
14049
|
{
|
|
13559
14050
|
"docs": {
|
|
13560
|
-
"
|
|
14051
|
+
"remarks": "This specifies the location of the file to be uploaded.",
|
|
14052
|
+
"summary": "- The file path or URL for the source of the blob's content."
|
|
13561
14053
|
},
|
|
13562
14054
|
"name": "filePath",
|
|
13563
14055
|
"type": {
|
|
@@ -13566,7 +14058,7 @@
|
|
|
13566
14058
|
},
|
|
13567
14059
|
{
|
|
13568
14060
|
"docs": {
|
|
13569
|
-
"summary": "Optional configuration properties for the blob,
|
|
14061
|
+
"summary": "- Optional configuration properties for the blob, which include: - `type`: The type of the blob (e.g., 'Block', 'Append', 'Page'). Default is 'Block'. - `contentType`: The MIME type of the blob's content, such as 'application/octet-stream' for binary data. This helps browsers and other clients handle the file correctly when it's downloaded or accessed. - `metadata`: A dictionary of key-value pairs to store as metadata with the blob. Metadata is typically used to store additional details about the blob, such as tags, descriptions, or other attributes."
|
|
13570
14062
|
},
|
|
13571
14063
|
"name": "props",
|
|
13572
14064
|
"optional": true,
|
|
@@ -13611,26 +14103,38 @@
|
|
|
13611
14103
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_storageaccount.File",
|
|
13612
14104
|
"initializer": {
|
|
13613
14105
|
"docs": {
|
|
13614
|
-
"
|
|
14106
|
+
"remarks": "This class is responsible for the creation and management of a file in an Azure Storage Share, which allows for cloud file storage\nthat can be accessed and managed like a file system. The File class enables detailed configuration of file properties including\ncontent type, encoding, and metadata, making it suitable for storing and accessing various types of data.",
|
|
14107
|
+
"stability": "stable",
|
|
14108
|
+
"summary": "Represents a file within an Azure Storage Share."
|
|
13615
14109
|
},
|
|
13616
14110
|
"locationInModule": {
|
|
13617
14111
|
"filename": "src/azure-storageaccount/lib/fileshare.ts",
|
|
13618
|
-
"line":
|
|
14112
|
+
"line": 154
|
|
13619
14113
|
},
|
|
13620
14114
|
"parameters": [
|
|
13621
14115
|
{
|
|
14116
|
+
"docs": {
|
|
14117
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
14118
|
+
},
|
|
13622
14119
|
"name": "scope",
|
|
13623
14120
|
"type": {
|
|
13624
14121
|
"fqn": "constructs.Construct"
|
|
13625
14122
|
}
|
|
13626
14123
|
},
|
|
13627
14124
|
{
|
|
14125
|
+
"docs": {
|
|
14126
|
+
"summary": "- The unique identifier for this instance of the file."
|
|
14127
|
+
},
|
|
13628
14128
|
"name": "id",
|
|
13629
14129
|
"type": {
|
|
13630
14130
|
"primitive": "string"
|
|
13631
14131
|
}
|
|
13632
14132
|
},
|
|
13633
14133
|
{
|
|
14134
|
+
"docs": {
|
|
14135
|
+
"remarks": "These properties include:\n - `name`: The name of the file within the storage share.\n - `storageShareId`: The identifier for the storage share in which this file is located.\n - `source`: The source of the file's content, which can be a path to a local file or a URL.\n - `contentType`: The MIME type of the file's content, helping clients handle the file appropriately when downloaded.\n - `contentEncoding`: The encoding format of the file's content (e.g., 'gzip').\n - `contentDisposition`: Provides instructions on how the content should be displayed or handled.\n - `contentMd5`: An MD5 hash of the file content for verifying the integrity of the file upon transfer.\n - `metadata`: A dictionary of key-value pairs to store as metadata with the file. Metadata is typically used to store additional\n details about the file such as tags, descriptions, or other attributes.\n\nExample usage:\n```typescript\nconst myFile = new File(this, 'MyFile', {\nname: 'examplefile.txt',\nstorageShareId: 'share123',\nsource: './path/to/local/file.txt',\ncontentType: 'text/plain',\ncontentEncoding: 'utf-8',\nmetadata: {\ncreatedBy: 'John Doe'\n}\n});\n```\nThis class initializes a file with the specified configurations and handles the uploading of content from the specified source, providing\na way to manage file storage in Azure efficiently.",
|
|
14136
|
+
"summary": "- Configuration properties for the Azure Storage Share File."
|
|
14137
|
+
},
|
|
13634
14138
|
"name": "props",
|
|
13635
14139
|
"type": {
|
|
13636
14140
|
"fqn": "@cdktf/provider-azurerm.storageShareFile.StorageShareFileConfig"
|
|
@@ -14077,26 +14581,38 @@
|
|
|
14077
14581
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_storageaccount.Queue",
|
|
14078
14582
|
"initializer": {
|
|
14079
14583
|
"docs": {
|
|
14080
|
-
"
|
|
14584
|
+
"remarks": "This class is responsible for the creation and management of an Azure Storage Queue, which is a service for storing large numbers\nof messages that can be accessed from anywhere in the world via authenticated calls using HTTP or HTTPS. A single queue message\ncan be up to 64 KB in size, and a queue can contain millions of messages, up to the total capacity limit of a storage account.\nThis class provides a way to manage messages in a scalable and secure manner.",
|
|
14585
|
+
"stability": "stable",
|
|
14586
|
+
"summary": "Represents an Azure Storage Queue within a specific Azure Storage Account."
|
|
14081
14587
|
},
|
|
14082
14588
|
"locationInModule": {
|
|
14083
14589
|
"filename": "src/azure-storageaccount/lib/queue.ts",
|
|
14084
|
-
"line":
|
|
14590
|
+
"line": 39
|
|
14085
14591
|
},
|
|
14086
14592
|
"parameters": [
|
|
14087
14593
|
{
|
|
14594
|
+
"docs": {
|
|
14595
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
14596
|
+
},
|
|
14088
14597
|
"name": "scope",
|
|
14089
14598
|
"type": {
|
|
14090
14599
|
"fqn": "constructs.Construct"
|
|
14091
14600
|
}
|
|
14092
14601
|
},
|
|
14093
14602
|
{
|
|
14603
|
+
"docs": {
|
|
14604
|
+
"summary": "- The unique identifier for this instance of the queue."
|
|
14605
|
+
},
|
|
14094
14606
|
"name": "id",
|
|
14095
14607
|
"type": {
|
|
14096
14608
|
"primitive": "string"
|
|
14097
14609
|
}
|
|
14098
14610
|
},
|
|
14099
14611
|
{
|
|
14612
|
+
"docs": {
|
|
14613
|
+
"remarks": "These properties may include:\n - `name`: The name of the queue, which must be unique within the storage account.\n - `storageAccountName`: The name of the storage account in which this queue is being created.\n - `metadata`: A dictionary of strings that represents metadata to associate with the queue.\n - `timeouts`: Custom timeout settings for CRUD operations on the queue to manage operation durations and retries.\n\nExample usage:\n```typescript\nconst myQueue = new Queue(this, 'MyQueue', {\nname: 'taskqueue',\nstorageAccountName: 'mystorageaccount',\nmetadata: {\ndepartment: 'IT'\n}\n});\n```\nThis class initializes a storage queue with the specified configurations. It can be used to enqueue and process messages as needed\nwithin applications, providing a reliable messaging solution for asynchronous communication and coordination of tasks across systems.",
|
|
14614
|
+
"summary": "- Configuration properties for the Azure Storage Queue."
|
|
14615
|
+
},
|
|
14100
14616
|
"name": "props",
|
|
14101
14617
|
"type": {
|
|
14102
14618
|
"fqn": "@cdktf/provider-azurerm.storageQueue.StorageQueueConfig"
|
|
@@ -14138,26 +14654,38 @@
|
|
|
14138
14654
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_storageaccount.Table",
|
|
14139
14655
|
"initializer": {
|
|
14140
14656
|
"docs": {
|
|
14141
|
-
"
|
|
14657
|
+
"remarks": "This class is responsible for the creation and management of an Azure Storage Table, which provides a NoSQL key-attribute data store\nthat can massively scale. It is suitable for storing structured, non-relational data, allowing rapid development and fast access to large\nquantities of data. The class facilitates creating and configuring storage tables including setting up access control lists (ACLs).",
|
|
14658
|
+
"stability": "stable",
|
|
14659
|
+
"summary": "Represents an Azure Storage Table within a specific Azure Storage Account."
|
|
14142
14660
|
},
|
|
14143
14661
|
"locationInModule": {
|
|
14144
14662
|
"filename": "src/azure-storageaccount/lib/table.ts",
|
|
14145
|
-
"line":
|
|
14663
|
+
"line": 41
|
|
14146
14664
|
},
|
|
14147
14665
|
"parameters": [
|
|
14148
14666
|
{
|
|
14667
|
+
"docs": {
|
|
14668
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
14669
|
+
},
|
|
14149
14670
|
"name": "scope",
|
|
14150
14671
|
"type": {
|
|
14151
14672
|
"fqn": "constructs.Construct"
|
|
14152
14673
|
}
|
|
14153
14674
|
},
|
|
14154
14675
|
{
|
|
14676
|
+
"docs": {
|
|
14677
|
+
"summary": "- The unique identifier for this instance of the table."
|
|
14678
|
+
},
|
|
14155
14679
|
"name": "id",
|
|
14156
14680
|
"type": {
|
|
14157
14681
|
"primitive": "string"
|
|
14158
14682
|
}
|
|
14159
14683
|
},
|
|
14160
14684
|
{
|
|
14685
|
+
"docs": {
|
|
14686
|
+
"remarks": "These properties include:\n - `name`: The name of the table, which must be unique within the storage account.\n - `storageAccountName`: The name of the storage account in which this table is being created.\n - `acl`: An optional list of access control entries that define permissions for accessing the table.\n - `timeouts`: Optional timeout settings for create/read/update/delete operations on the table.\n\nExample usage:\n```typescript\nconst storageTable = new Table(this, 'MyTable', {\nname: 'tasktable',\nstorageAccountName: 'mystorageaccount',\nacl: [{\nid: 'myacl',\npermissions: 'rwdl',\nstart: '2020-01-01T01:00:00Z',\nexpiry: '2030-01-01T01:00:00Z',\npolicy: 'mypolicy'\n}]\n});\n```\nThis class initializes a storage table with the specified configurations and provides an interface to manage access controls and\nother properties. It is ideal for applications that require structured, scalable, and fast access to data.",
|
|
14687
|
+
"summary": "- Configuration properties for the Azure Storage Table."
|
|
14688
|
+
},
|
|
14161
14689
|
"name": "props",
|
|
14162
14690
|
"type": {
|
|
14163
14691
|
"fqn": "@cdktf/provider-azurerm.storageTable.StorageTableConfig"
|
|
@@ -14305,17 +14833,18 @@
|
|
|
14305
14833
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualmachine.LinuxVM",
|
|
14306
14834
|
"initializer": {
|
|
14307
14835
|
"docs": {
|
|
14836
|
+
"remarks": "This class is designed to provision and manage a Linux VM in Azure, facilitating detailed configuration including\nVM size, the operating system image, network settings, and administrative credentials. It supports custom data scripts,\nSSH configurations, and optional features like managed identity and boot diagnostics.",
|
|
14308
14837
|
"stability": "stable",
|
|
14309
|
-
"summary": "
|
|
14838
|
+
"summary": "Represents a Linux-based Virtual Machine (VM) within Microsoft Azure."
|
|
14310
14839
|
},
|
|
14311
14840
|
"locationInModule": {
|
|
14312
14841
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14313
|
-
"line":
|
|
14842
|
+
"line": 426
|
|
14314
14843
|
},
|
|
14315
14844
|
"parameters": [
|
|
14316
14845
|
{
|
|
14317
14846
|
"docs": {
|
|
14318
|
-
"summary": "- The scope in which this construct
|
|
14847
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) application."
|
|
14319
14848
|
},
|
|
14320
14849
|
"name": "scope",
|
|
14321
14850
|
"type": {
|
|
@@ -14324,7 +14853,7 @@
|
|
|
14324
14853
|
},
|
|
14325
14854
|
{
|
|
14326
14855
|
"docs": {
|
|
14327
|
-
"summary": "- The
|
|
14856
|
+
"summary": "- The unique identifier for this instance of the Linux VM, used within the scope for reference."
|
|
14328
14857
|
},
|
|
14329
14858
|
"name": "id",
|
|
14330
14859
|
"type": {
|
|
@@ -14333,7 +14862,8 @@
|
|
|
14333
14862
|
},
|
|
14334
14863
|
{
|
|
14335
14864
|
"docs": {
|
|
14336
|
-
"
|
|
14865
|
+
"remarks": "These include:\n - `location`: The geographic location where the VM will be hosted (e.g., \"eastus\").\n - `name`: The name of the VM, which must be unique within the resource group.\n - `resourceGroup`: The ResourceGroup within which the VM will be created.\n - `size`: The size specification of the VM (e.g., \"Standard_B2s\").\n - `availabilitySetId`: The ID of the availability set in which to include the VM.\n - `userData`: Custom data scripts to pass to the VM upon creation.\n - `adminSshKey`: SSH keys for secure access to the VM.\n - `zone`: The availability zone for deploying the VM.\n - `identity`: Managed identity settings for accessing other Azure services.\n - `additionalCapabilities`: Special capabilities like Ultra Disk support.\n - `sourceImageReference`: A reference to the specific Linux image to be used for the VM.\n - `sourceImageId`: The identifier for a custom image to use for the VM.\n - `tags`: Key-value pairs for resource tagging.\n - `osDisk`: Configuration for the VM's operating system disk.\n - `subnet`: Specifies the subnet within which the VM will be placed.\n - `publicIPAllocationMethod`: Method used to allocate a public IP address.\n - `customData`: Additional scripts or commands passed to the VM at startup.\n - `enableSshAzureADLogin`: Option to enable Azure AD login for SSH.\n - `bootDiagnosticsStorageURI`: URI for storage where VM boot diagnostics are collected.\n\nExample usage:\n```typescript\nconst linuxVM = new LinuxVM(this, 'MyLinuxVM', {\nresourceGroup: myResourceGroup,\nname: 'myVM',\nsize: 'Standard_DS1_v2',\nadminUsername: 'adminuser',\nadminSshKey: [{ publicKey: 'ssh-rsa AAAAB...' }],\nsourceImageReference: { publisher: 'Canonical', offer: 'UbuntuServer', sku: '18.04-LTS', version: 'latest' },\nosDisk: { caching: 'ReadWrite', storageAccountType: 'Standard_LRS' },\nsubnet: mySubnet,\ntags: { environment: 'production' }\n});\n```\nThis class initializes a Linux VM with the specified configurations, handling details like network setup, OS installation,\nand security settings, thus providing a robust infrastructure for hosting applications on Linux environments.",
|
|
14866
|
+
"summary": "- Configuration properties for the Linux Virtual Machine, derived from the LinuxVMProps interface."
|
|
14337
14867
|
},
|
|
14338
14868
|
"name": "props",
|
|
14339
14869
|
"type": {
|
|
@@ -14345,7 +14875,7 @@
|
|
|
14345
14875
|
"kind": "class",
|
|
14346
14876
|
"locationInModule": {
|
|
14347
14877
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14348
|
-
"line":
|
|
14878
|
+
"line": 371
|
|
14349
14879
|
},
|
|
14350
14880
|
"name": "LinuxVM",
|
|
14351
14881
|
"namespace": "azure_virtualmachine",
|
|
@@ -14357,7 +14887,7 @@
|
|
|
14357
14887
|
"immutable": true,
|
|
14358
14888
|
"locationInModule": {
|
|
14359
14889
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14360
|
-
"line":
|
|
14890
|
+
"line": 376
|
|
14361
14891
|
},
|
|
14362
14892
|
"name": "name",
|
|
14363
14893
|
"type": {
|
|
@@ -14371,7 +14901,7 @@
|
|
|
14371
14901
|
"immutable": true,
|
|
14372
14902
|
"locationInModule": {
|
|
14373
14903
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14374
|
-
"line":
|
|
14904
|
+
"line": 373
|
|
14375
14905
|
},
|
|
14376
14906
|
"name": "props",
|
|
14377
14907
|
"type": {
|
|
@@ -14385,7 +14915,7 @@
|
|
|
14385
14915
|
"immutable": true,
|
|
14386
14916
|
"locationInModule": {
|
|
14387
14917
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14388
|
-
"line":
|
|
14918
|
+
"line": 377
|
|
14389
14919
|
},
|
|
14390
14920
|
"name": "publicIp",
|
|
14391
14921
|
"optional": true,
|
|
@@ -14399,7 +14929,7 @@
|
|
|
14399
14929
|
},
|
|
14400
14930
|
"locationInModule": {
|
|
14401
14931
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14402
|
-
"line":
|
|
14932
|
+
"line": 375
|
|
14403
14933
|
},
|
|
14404
14934
|
"name": "id",
|
|
14405
14935
|
"overrides": "@microsoft/terraform-cdk-constructs.core_azure.AzureResource",
|
|
@@ -14413,7 +14943,7 @@
|
|
|
14413
14943
|
},
|
|
14414
14944
|
"locationInModule": {
|
|
14415
14945
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14416
|
-
"line":
|
|
14946
|
+
"line": 374
|
|
14417
14947
|
},
|
|
14418
14948
|
"name": "resourceGroup",
|
|
14419
14949
|
"overrides": "@microsoft/terraform-cdk-constructs.core_azure.AzureResource",
|
|
@@ -14434,7 +14964,7 @@
|
|
|
14434
14964
|
"kind": "interface",
|
|
14435
14965
|
"locationInModule": {
|
|
14436
14966
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14437
|
-
"line":
|
|
14967
|
+
"line": 253
|
|
14438
14968
|
},
|
|
14439
14969
|
"name": "LinuxVMProps",
|
|
14440
14970
|
"namespace": "azure_virtualmachine",
|
|
@@ -14448,7 +14978,7 @@
|
|
|
14448
14978
|
"immutable": true,
|
|
14449
14979
|
"locationInModule": {
|
|
14450
14980
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14451
|
-
"line":
|
|
14981
|
+
"line": 269
|
|
14452
14982
|
},
|
|
14453
14983
|
"name": "resourceGroup",
|
|
14454
14984
|
"type": {
|
|
@@ -14464,7 +14994,7 @@
|
|
|
14464
14994
|
"immutable": true,
|
|
14465
14995
|
"locationInModule": {
|
|
14466
14996
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14467
|
-
"line":
|
|
14997
|
+
"line": 305
|
|
14468
14998
|
},
|
|
14469
14999
|
"name": "additionalCapabilities",
|
|
14470
15000
|
"optional": true,
|
|
@@ -14481,7 +15011,7 @@
|
|
|
14481
15011
|
"immutable": true,
|
|
14482
15012
|
"locationInModule": {
|
|
14483
15013
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14484
|
-
"line":
|
|
15014
|
+
"line": 320
|
|
14485
15015
|
},
|
|
14486
15016
|
"name": "adminPassword",
|
|
14487
15017
|
"optional": true,
|
|
@@ -14498,7 +15028,7 @@
|
|
|
14498
15028
|
"immutable": true,
|
|
14499
15029
|
"locationInModule": {
|
|
14500
15030
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14501
|
-
"line":
|
|
15031
|
+
"line": 290
|
|
14502
15032
|
},
|
|
14503
15033
|
"name": "adminSshKey",
|
|
14504
15034
|
"optional": true,
|
|
@@ -14529,7 +15059,7 @@
|
|
|
14529
15059
|
"immutable": true,
|
|
14530
15060
|
"locationInModule": {
|
|
14531
15061
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14532
|
-
"line":
|
|
15062
|
+
"line": 315
|
|
14533
15063
|
},
|
|
14534
15064
|
"name": "adminUsername",
|
|
14535
15065
|
"optional": true,
|
|
@@ -14546,7 +15076,7 @@
|
|
|
14546
15076
|
"immutable": true,
|
|
14547
15077
|
"locationInModule": {
|
|
14548
15078
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14549
|
-
"line":
|
|
15079
|
+
"line": 280
|
|
14550
15080
|
},
|
|
14551
15081
|
"name": "availabilitySetId",
|
|
14552
15082
|
"optional": true,
|
|
@@ -14563,7 +15093,7 @@
|
|
|
14563
15093
|
"immutable": true,
|
|
14564
15094
|
"locationInModule": {
|
|
14565
15095
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14566
|
-
"line":
|
|
15096
|
+
"line": 368
|
|
14567
15097
|
},
|
|
14568
15098
|
"name": "bootDiagnosticsStorageURI",
|
|
14569
15099
|
"optional": true,
|
|
@@ -14580,7 +15110,7 @@
|
|
|
14580
15110
|
"immutable": true,
|
|
14581
15111
|
"locationInModule": {
|
|
14582
15112
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14583
|
-
"line":
|
|
15113
|
+
"line": 358
|
|
14584
15114
|
},
|
|
14585
15115
|
"name": "customData",
|
|
14586
15116
|
"optional": true,
|
|
@@ -14597,7 +15127,7 @@
|
|
|
14597
15127
|
"immutable": true,
|
|
14598
15128
|
"locationInModule": {
|
|
14599
15129
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14600
|
-
"line":
|
|
15130
|
+
"line": 363
|
|
14601
15131
|
},
|
|
14602
15132
|
"name": "enableSshAzureADLogin",
|
|
14603
15133
|
"optional": true,
|
|
@@ -14614,7 +15144,7 @@
|
|
|
14614
15144
|
"immutable": true,
|
|
14615
15145
|
"locationInModule": {
|
|
14616
15146
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14617
|
-
"line":
|
|
15147
|
+
"line": 300
|
|
14618
15148
|
},
|
|
14619
15149
|
"name": "identity",
|
|
14620
15150
|
"optional": true,
|
|
@@ -14632,7 +15162,7 @@
|
|
|
14632
15162
|
"immutable": true,
|
|
14633
15163
|
"locationInModule": {
|
|
14634
15164
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14635
|
-
"line":
|
|
15165
|
+
"line": 258
|
|
14636
15166
|
},
|
|
14637
15167
|
"name": "location",
|
|
14638
15168
|
"optional": true,
|
|
@@ -14650,7 +15180,7 @@
|
|
|
14650
15180
|
"immutable": true,
|
|
14651
15181
|
"locationInModule": {
|
|
14652
15182
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14653
|
-
"line":
|
|
15183
|
+
"line": 264
|
|
14654
15184
|
},
|
|
14655
15185
|
"name": "name",
|
|
14656
15186
|
"optional": true,
|
|
@@ -14668,7 +15198,7 @@
|
|
|
14668
15198
|
"immutable": true,
|
|
14669
15199
|
"locationInModule": {
|
|
14670
15200
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14671
|
-
"line":
|
|
15201
|
+
"line": 342
|
|
14672
15202
|
},
|
|
14673
15203
|
"name": "osDisk",
|
|
14674
15204
|
"optional": true,
|
|
@@ -14685,7 +15215,7 @@
|
|
|
14685
15215
|
"immutable": true,
|
|
14686
15216
|
"locationInModule": {
|
|
14687
15217
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14688
|
-
"line":
|
|
15218
|
+
"line": 353
|
|
14689
15219
|
},
|
|
14690
15220
|
"name": "publicIPAllocationMethod",
|
|
14691
15221
|
"optional": true,
|
|
@@ -14702,7 +15232,7 @@
|
|
|
14702
15232
|
"immutable": true,
|
|
14703
15233
|
"locationInModule": {
|
|
14704
15234
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14705
|
-
"line":
|
|
15235
|
+
"line": 310
|
|
14706
15236
|
},
|
|
14707
15237
|
"name": "secret",
|
|
14708
15238
|
"optional": true,
|
|
@@ -14725,7 +15255,7 @@
|
|
|
14725
15255
|
"immutable": true,
|
|
14726
15256
|
"locationInModule": {
|
|
14727
15257
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14728
|
-
"line":
|
|
15258
|
+
"line": 275
|
|
14729
15259
|
},
|
|
14730
15260
|
"name": "size",
|
|
14731
15261
|
"optional": true,
|
|
@@ -14742,7 +15272,7 @@
|
|
|
14742
15272
|
"immutable": true,
|
|
14743
15273
|
"locationInModule": {
|
|
14744
15274
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14745
|
-
"line":
|
|
15275
|
+
"line": 331
|
|
14746
15276
|
},
|
|
14747
15277
|
"name": "sourceImageId",
|
|
14748
15278
|
"optional": true,
|
|
@@ -14760,7 +15290,7 @@
|
|
|
14760
15290
|
"immutable": true,
|
|
14761
15291
|
"locationInModule": {
|
|
14762
15292
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14763
|
-
"line":
|
|
15293
|
+
"line": 326
|
|
14764
15294
|
},
|
|
14765
15295
|
"name": "sourceImageReference",
|
|
14766
15296
|
"optional": true,
|
|
@@ -14778,7 +15308,7 @@
|
|
|
14778
15308
|
"immutable": true,
|
|
14779
15309
|
"locationInModule": {
|
|
14780
15310
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14781
|
-
"line":
|
|
15311
|
+
"line": 348
|
|
14782
15312
|
},
|
|
14783
15313
|
"name": "subnet",
|
|
14784
15314
|
"optional": true,
|
|
@@ -14795,7 +15325,7 @@
|
|
|
14795
15325
|
"immutable": true,
|
|
14796
15326
|
"locationInModule": {
|
|
14797
15327
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14798
|
-
"line":
|
|
15328
|
+
"line": 336
|
|
14799
15329
|
},
|
|
14800
15330
|
"name": "tags",
|
|
14801
15331
|
"optional": true,
|
|
@@ -14817,7 +15347,7 @@
|
|
|
14817
15347
|
"immutable": true,
|
|
14818
15348
|
"locationInModule": {
|
|
14819
15349
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14820
|
-
"line":
|
|
15350
|
+
"line": 285
|
|
14821
15351
|
},
|
|
14822
15352
|
"name": "userData",
|
|
14823
15353
|
"optional": true,
|
|
@@ -14834,7 +15364,7 @@
|
|
|
14834
15364
|
"immutable": true,
|
|
14835
15365
|
"locationInModule": {
|
|
14836
15366
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
14837
|
-
"line":
|
|
15367
|
+
"line": 295
|
|
14838
15368
|
},
|
|
14839
15369
|
"name": "zone",
|
|
14840
15370
|
"optional": true,
|
|
@@ -15016,17 +15546,18 @@
|
|
|
15016
15546
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualmachine.WindowsVM",
|
|
15017
15547
|
"initializer": {
|
|
15018
15548
|
"docs": {
|
|
15549
|
+
"remarks": "This class is designed to provision and manage a Windows VM in Azure, allowing for detailed configuration including\nthe VM's size, the operating system image, network settings, and administrative credentials. It supports customization\nof the OS disk, networking setup, and optional features like custom data scripts and boot diagnostics.",
|
|
15019
15550
|
"stability": "stable",
|
|
15020
|
-
"summary": "
|
|
15551
|
+
"summary": "Represents a Windows-based Virtual Machine (VM) within Microsoft Azure."
|
|
15021
15552
|
},
|
|
15022
15553
|
"locationInModule": {
|
|
15023
15554
|
"filename": "src/azure-virtualmachine/lib/vm.ts",
|
|
15024
|
-
"line":
|
|
15555
|
+
"line": 160
|
|
15025
15556
|
},
|
|
15026
15557
|
"parameters": [
|
|
15027
15558
|
{
|
|
15028
15559
|
"docs": {
|
|
15029
|
-
"summary": "- The scope in which this construct
|
|
15560
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) application."
|
|
15030
15561
|
},
|
|
15031
15562
|
"name": "scope",
|
|
15032
15563
|
"type": {
|
|
@@ -15035,7 +15566,7 @@
|
|
|
15035
15566
|
},
|
|
15036
15567
|
{
|
|
15037
15568
|
"docs": {
|
|
15038
|
-
"summary": "- The
|
|
15569
|
+
"summary": "- The unique identifier for this instance of the Windows VM, used within the scope for reference."
|
|
15039
15570
|
},
|
|
15040
15571
|
"name": "id",
|
|
15041
15572
|
"type": {
|
|
@@ -15044,7 +15575,8 @@
|
|
|
15044
15575
|
},
|
|
15045
15576
|
{
|
|
15046
15577
|
"docs": {
|
|
15047
|
-
"
|
|
15578
|
+
"remarks": "These include:\n - `location`: The geographic location where the VM will be hosted (e.g., \"eastus\").\n - `name`: The name of the VM, which must be unique within the resource group.\n - `resourceGroup`: The ResourceGroup within which the VM will be created.\n - `size`: The size specification of the VM (e.g., \"Standard_B2s\").\n - `adminUsername`: The administrator username for accessing the VM.\n - `adminPassword`: The administrator password for accessing the VM.\n - `sourceImageReference`: A reference to the specific Windows image to be used for the VM.\n - `sourceImageId`: The identifier for a custom image to use for the VM.\n - `tags`: Key-value pairs for resource tagging.\n - `osDisk`: Configuration for the VM's operating system disk.\n - `subnet`: Specifies the subnet within which the VM will be placed.\n - `publicIPAllocationMethod`: The method used to allocate a public IP address to the VM.\n - `customData`: Scripts or commands passed to the VM at startup.\n - `bootstrapCustomData`: Custom data used to trigger the Azure Custom Script Extension for VM setup tasks.\n - `bootDiagnosticsStorageURI`: URI for storage where VM boot diagnostics are collected.\n\nExample usage:\n```typescript\nconst vm = new WindowsVM(this, 'MyWindowsVM', {\nresourceGroup: myResourceGroup,\nname: 'myVM',\nsize: 'Standard_DS1_v2',\nadminUsername: 'adminuser',\nadminPassword: 'securepassword123',\nsourceImageReference: { publisher: 'MicrosoftWindowsServer', offer: 'WindowsServer', sku: '2019-Datacenter', version: 'latest' },\nosDisk: { caching: 'ReadWrite', storageAccountType: 'Standard_LRS' },\nsubnet: mySubnet,\ntags: { environment: 'production' }\n});\n```\nThis class initializes a Windows VM with the specified configurations, handling details like network setup, OS installation,\nand security settings, thus providing a robust infrastructure for hosting applications on Windows Server environments.",
|
|
15579
|
+
"summary": "- Configuration properties for the Windows Virtual Machine, derived from the WindowsVMProps interface."
|
|
15048
15580
|
},
|
|
15049
15581
|
"name": "props",
|
|
15050
15582
|
"type": {
|
|
@@ -15426,17 +15958,18 @@
|
|
|
15426
15958
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualmachinescaleset.LinuxCluster",
|
|
15427
15959
|
"initializer": {
|
|
15428
15960
|
"docs": {
|
|
15961
|
+
"remarks": "This class is designed to provision and manage a scale set of Linux virtual machines, providing capabilities such as\nauto-scaling, high availability, and simplified management. It supports detailed configurations like VM size, operating\nsystem image, network settings, and administrative credentials. Additional functionalities include custom data scripts,\nSSH configurations, and optional features like managed identity and boot diagnostics.",
|
|
15429
15962
|
"stability": "stable",
|
|
15430
|
-
"summary": "
|
|
15963
|
+
"summary": "Represents a Linux Virtual Machine Scale Set (VMSS) within Microsoft Azure."
|
|
15431
15964
|
},
|
|
15432
15965
|
"locationInModule": {
|
|
15433
15966
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
15434
|
-
"line":
|
|
15967
|
+
"line": 216
|
|
15435
15968
|
},
|
|
15436
15969
|
"parameters": [
|
|
15437
15970
|
{
|
|
15438
15971
|
"docs": {
|
|
15439
|
-
"summary": "- The scope in which this construct
|
|
15972
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) application."
|
|
15440
15973
|
},
|
|
15441
15974
|
"name": "scope",
|
|
15442
15975
|
"type": {
|
|
@@ -15445,7 +15978,7 @@
|
|
|
15445
15978
|
},
|
|
15446
15979
|
{
|
|
15447
15980
|
"docs": {
|
|
15448
|
-
"summary": "- The
|
|
15981
|
+
"summary": "- The unique identifier for this instance of the Linux cluster, used within the scope for reference."
|
|
15449
15982
|
},
|
|
15450
15983
|
"name": "id",
|
|
15451
15984
|
"type": {
|
|
@@ -15454,7 +15987,8 @@
|
|
|
15454
15987
|
},
|
|
15455
15988
|
{
|
|
15456
15989
|
"docs": {
|
|
15457
|
-
"
|
|
15990
|
+
"remarks": "These include:\n - `location`: The geographic location where the scale set will be hosted (e.g., \"eastus\").\n - `name`: The name of the scale set, which must be unique within the resource group.\n - `resourceGroup`: The ResourceGroup within which the scale set will be created.\n - `sku`: The size specification of the VMs (e.g., \"Standard_B2s\").\n - `adminUsername`: The administrator username for the VMs.\n - `adminPassword`: The administrator password for the VMs.\n - `adminSshKey`: SSH keys for secure access to the VMs.\n - `zones`: The availability zones for deploying the VMs.\n - `identity`: Managed identity settings for accessing other Azure services.\n - `sourceImageReference`: A reference to the specific Linux image to be used for the VMs.\n - `sourceImageId`: The identifier for a custom image to use for the VMs.\n - `tags`: Key-value pairs for resource tagging.\n - `osDisk`: Configuration for the VMs' operating system disks.\n - `subnet`: Specifies the subnet within which the VMs will be placed.\n - `publicIPAddress`: Method used to allocate public IP addresses to the VMs.\n - `customData`: Scripts or commands passed to the VMs at startup.\n - `instances`: The number of VM instances in the scale set.\n - `upgradePolicyMode`: The upgrade policy mode for the VMSS.\n - `overprovision`: Specifies if the VMSS should be overprovisioned to maintain capacity during updates.\n - `scaleInPolicy`: The scale-in policy for the VMSS.\n - `bootDiagnosticsStorageURI`: URI for storage where VMSS boot diagnostics are collected.\n - `enableSshAzureADLogin`: Option to enable Azure AD login for SSH on the VMs.\n\nExample usage:\n```typescript\nconst linuxCluster = new LinuxCluster(this, 'MyLinuxCluster', {\nresourceGroup: myResourceGroup,\nname: 'myCluster',\nsku: 'Standard_DS1_v2',\nadminUsername: 'adminuser',\nadminSshKey: [{ publicKey: 'ssh-rsa AAAAB...' }],\nsourceImageReference: { publisher: 'Canonical', offer: 'UbuntuServer', sku: '18.04-LTS', version: 'latest' },\nosDisk: { caching: 'ReadWrite', storageAccountType: 'Standard_LRS' },\nsubnet: mySubnet,\ninstances: 3,\ntags: { environment: 'production' }\n});\n```\nThis class initializes a Linux VM Scale Set with the specified configurations, handling details like VM creation,\nscaling policies, network setup, OS installation, and security settings, providing a robust and scalable infrastructure\nfor hosting cloud-based Linux applications.",
|
|
15991
|
+
"summary": "- Configuration properties for the Linux VM Scale Set, derived from the LinuxClusterProps interface."
|
|
15458
15992
|
},
|
|
15459
15993
|
"name": "props",
|
|
15460
15994
|
"type": {
|
|
@@ -15998,17 +16532,18 @@
|
|
|
15998
16532
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualmachinescaleset.WindowsCluster",
|
|
15999
16533
|
"initializer": {
|
|
16000
16534
|
"docs": {
|
|
16535
|
+
"remarks": "This class provides a way to deploy and manage a scale set of Windows virtual machines, allowing for configurations such as\nauto-scaling, high availability, and simplified patch management. It supports detailed specifications including\nVM size, the operating system image, network settings, and administrative credentials. Additional capabilities include\ncustom data scripts, automatic OS updates, and optional features like managed identity and boot diagnostics.",
|
|
16001
16536
|
"stability": "stable",
|
|
16002
|
-
"summary": "
|
|
16537
|
+
"summary": "Represents a Windows Virtual Machine Scale Set (VMSS) within Microsoft Azure."
|
|
16003
16538
|
},
|
|
16004
16539
|
"locationInModule": {
|
|
16005
16540
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16006
|
-
"line":
|
|
16541
|
+
"line": 465
|
|
16007
16542
|
},
|
|
16008
16543
|
"parameters": [
|
|
16009
16544
|
{
|
|
16010
16545
|
"docs": {
|
|
16011
|
-
"summary": "- The scope in which this construct
|
|
16546
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) application."
|
|
16012
16547
|
},
|
|
16013
16548
|
"name": "scope",
|
|
16014
16549
|
"type": {
|
|
@@ -16017,7 +16552,7 @@
|
|
|
16017
16552
|
},
|
|
16018
16553
|
{
|
|
16019
16554
|
"docs": {
|
|
16020
|
-
"summary": "- The
|
|
16555
|
+
"summary": "- The unique identifier for this instance of the Windows cluster, used within the scope for reference."
|
|
16021
16556
|
},
|
|
16022
16557
|
"name": "id",
|
|
16023
16558
|
"type": {
|
|
@@ -16026,7 +16561,8 @@
|
|
|
16026
16561
|
},
|
|
16027
16562
|
{
|
|
16028
16563
|
"docs": {
|
|
16029
|
-
"
|
|
16564
|
+
"remarks": "These include:\n - `location`: The geographic location where the scale set will be hosted (e.g., \"eastus\").\n - `name`: The name of the scale set, which must be unique within the resource group.\n - `resourceGroup`: The ResourceGroup within which the scale set will be created.\n - `sku`: The size specification of the VMs (e.g., \"Standard_B2s\").\n - `adminUsername`: The administrator username for the VMs.\n - `adminPassword`: The administrator password for the VMs.\n - `zones`: The availability zones for deploying the VMs.\n - `instances`: The number of VM instances in the scale set.\n - `sourceImageReference`: A reference to the specific Windows image to be used for the VMs.\n - `sourceImageId`: The identifier for a custom image to use for the VMs.\n - `tags`: Key-value pairs for resource tagging.\n - `osDisk`: Configuration for the VMs' operating system disks.\n - `subnet`: Specifies the subnet within which the VMs will be placed.\n - `publicIPAddress`: Method used to allocate public IP addresses to the VMs.\n - `customData`: Scripts or commands passed to the VMs at startup.\n - `upgradePolicyMode`: The upgrade policy mode for the VMSS.\n - `overprovision`: Specifies if the VMSS should be overprovisioned to maintain capacity during updates.\n - `scaleInPolicy`: The scale-in policy for the VMSS.\n - `bootDiagnosticsStorageURI`: URI for storage where VMSS boot diagnostics are collected.\n - `enableSshAzureADLogin`: Option to enable Azure AD login for SSH on the VMs.\n\nExample usage:\n```typescript\nconst windowsCluster = new WindowsCluster(this, 'MyWindowsCluster', {\nresourceGroup: myResourceGroup,\nname: 'myCluster',\nsku: 'Standard_DS1_v2',\nadminUsername: 'adminuser',\nadminPassword: 'securepassword123',\nsourceImageReference: { publisher: 'MicrosoftWindowsServer', offer: 'WindowsServer', sku: '2019-Datacenter', version: 'latest' },\nosDisk: { caching: 'ReadWrite', storageAccountType: 'Standard_LRS' },\nsubnet: mySubnet,\ninstances: 3,\ntags: { environment: 'production' }\n});\n```\nThis class initializes a Windows VM Scale Set with the specified configurations, handling details like VM creation,\nscaling policies, network setup, OS installation, and security settings, providing a robust and scalable infrastructure\nfor hosting cloud-based Windows applications.",
|
|
16565
|
+
"summary": "- Configuration properties for the Windows VM Scale Set, derived from the WindowsClusterProps interface."
|
|
16030
16566
|
},
|
|
16031
16567
|
"name": "props",
|
|
16032
16568
|
"type": {
|
|
@@ -16038,7 +16574,7 @@
|
|
|
16038
16574
|
"kind": "class",
|
|
16039
16575
|
"locationInModule": {
|
|
16040
16576
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16041
|
-
"line":
|
|
16577
|
+
"line": 408
|
|
16042
16578
|
},
|
|
16043
16579
|
"name": "WindowsCluster",
|
|
16044
16580
|
"namespace": "azure_virtualmachinescaleset",
|
|
@@ -16050,7 +16586,7 @@
|
|
|
16050
16586
|
"immutable": true,
|
|
16051
16587
|
"locationInModule": {
|
|
16052
16588
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16053
|
-
"line":
|
|
16589
|
+
"line": 412
|
|
16054
16590
|
},
|
|
16055
16591
|
"name": "name",
|
|
16056
16592
|
"type": {
|
|
@@ -16064,7 +16600,7 @@
|
|
|
16064
16600
|
"immutable": true,
|
|
16065
16601
|
"locationInModule": {
|
|
16066
16602
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16067
|
-
"line":
|
|
16603
|
+
"line": 409
|
|
16068
16604
|
},
|
|
16069
16605
|
"name": "props",
|
|
16070
16606
|
"type": {
|
|
@@ -16077,7 +16613,7 @@
|
|
|
16077
16613
|
},
|
|
16078
16614
|
"locationInModule": {
|
|
16079
16615
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16080
|
-
"line":
|
|
16616
|
+
"line": 411
|
|
16081
16617
|
},
|
|
16082
16618
|
"name": "id",
|
|
16083
16619
|
"overrides": "@microsoft/terraform-cdk-constructs.core_azure.AzureResource",
|
|
@@ -16091,7 +16627,7 @@
|
|
|
16091
16627
|
},
|
|
16092
16628
|
"locationInModule": {
|
|
16093
16629
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16094
|
-
"line":
|
|
16630
|
+
"line": 410
|
|
16095
16631
|
},
|
|
16096
16632
|
"name": "resourceGroup",
|
|
16097
16633
|
"overrides": "@microsoft/terraform-cdk-constructs.core_azure.AzureResource",
|
|
@@ -16112,7 +16648,7 @@
|
|
|
16112
16648
|
"kind": "interface",
|
|
16113
16649
|
"locationInModule": {
|
|
16114
16650
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16115
|
-
"line":
|
|
16651
|
+
"line": 298
|
|
16116
16652
|
},
|
|
16117
16653
|
"name": "WindowsClusterProps",
|
|
16118
16654
|
"namespace": "azure_virtualmachinescaleset",
|
|
@@ -16126,7 +16662,7 @@
|
|
|
16126
16662
|
"immutable": true,
|
|
16127
16663
|
"locationInModule": {
|
|
16128
16664
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16129
|
-
"line":
|
|
16665
|
+
"line": 330
|
|
16130
16666
|
},
|
|
16131
16667
|
"name": "adminPassword",
|
|
16132
16668
|
"type": {
|
|
@@ -16142,7 +16678,7 @@
|
|
|
16142
16678
|
"immutable": true,
|
|
16143
16679
|
"locationInModule": {
|
|
16144
16680
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16145
|
-
"line":
|
|
16681
|
+
"line": 325
|
|
16146
16682
|
},
|
|
16147
16683
|
"name": "adminUsername",
|
|
16148
16684
|
"type": {
|
|
@@ -16158,7 +16694,7 @@
|
|
|
16158
16694
|
"immutable": true,
|
|
16159
16695
|
"locationInModule": {
|
|
16160
16696
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16161
|
-
"line":
|
|
16697
|
+
"line": 314
|
|
16162
16698
|
},
|
|
16163
16699
|
"name": "resourceGroup",
|
|
16164
16700
|
"type": {
|
|
@@ -16175,7 +16711,7 @@
|
|
|
16175
16711
|
"immutable": true,
|
|
16176
16712
|
"locationInModule": {
|
|
16177
16713
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16178
|
-
"line":
|
|
16714
|
+
"line": 389
|
|
16179
16715
|
},
|
|
16180
16716
|
"name": "boostrapCustomData",
|
|
16181
16717
|
"optional": true,
|
|
@@ -16192,7 +16728,7 @@
|
|
|
16192
16728
|
"immutable": true,
|
|
16193
16729
|
"locationInModule": {
|
|
16194
16730
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16195
|
-
"line":
|
|
16731
|
+
"line": 394
|
|
16196
16732
|
},
|
|
16197
16733
|
"name": "bootDiagnosticsStorageURI",
|
|
16198
16734
|
"optional": true,
|
|
@@ -16209,7 +16745,7 @@
|
|
|
16209
16745
|
"immutable": true,
|
|
16210
16746
|
"locationInModule": {
|
|
16211
16747
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16212
|
-
"line":
|
|
16748
|
+
"line": 384
|
|
16213
16749
|
},
|
|
16214
16750
|
"name": "customData",
|
|
16215
16751
|
"optional": true,
|
|
@@ -16227,7 +16763,7 @@
|
|
|
16227
16763
|
"immutable": true,
|
|
16228
16764
|
"locationInModule": {
|
|
16229
16765
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16230
|
-
"line":
|
|
16766
|
+
"line": 341
|
|
16231
16767
|
},
|
|
16232
16768
|
"name": "instances",
|
|
16233
16769
|
"optional": true,
|
|
@@ -16245,7 +16781,7 @@
|
|
|
16245
16781
|
"immutable": true,
|
|
16246
16782
|
"locationInModule": {
|
|
16247
16783
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16248
|
-
"line":
|
|
16784
|
+
"line": 303
|
|
16249
16785
|
},
|
|
16250
16786
|
"name": "location",
|
|
16251
16787
|
"optional": true,
|
|
@@ -16263,7 +16799,7 @@
|
|
|
16263
16799
|
"immutable": true,
|
|
16264
16800
|
"locationInModule": {
|
|
16265
16801
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16266
|
-
"line":
|
|
16802
|
+
"line": 309
|
|
16267
16803
|
},
|
|
16268
16804
|
"name": "name",
|
|
16269
16805
|
"optional": true,
|
|
@@ -16281,7 +16817,7 @@
|
|
|
16281
16817
|
"immutable": true,
|
|
16282
16818
|
"locationInModule": {
|
|
16283
16819
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16284
|
-
"line":
|
|
16820
|
+
"line": 363
|
|
16285
16821
|
},
|
|
16286
16822
|
"name": "osDisk",
|
|
16287
16823
|
"optional": true,
|
|
@@ -16299,7 +16835,7 @@
|
|
|
16299
16835
|
"immutable": true,
|
|
16300
16836
|
"locationInModule": {
|
|
16301
16837
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16302
|
-
"line":
|
|
16838
|
+
"line": 400
|
|
16303
16839
|
},
|
|
16304
16840
|
"name": "overprovision",
|
|
16305
16841
|
"optional": true,
|
|
@@ -16316,7 +16852,7 @@
|
|
|
16316
16852
|
"immutable": true,
|
|
16317
16853
|
"locationInModule": {
|
|
16318
16854
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16319
|
-
"line":
|
|
16855
|
+
"line": 374
|
|
16320
16856
|
},
|
|
16321
16857
|
"name": "publicIPAddress",
|
|
16322
16858
|
"optional": true,
|
|
@@ -16338,7 +16874,7 @@
|
|
|
16338
16874
|
"immutable": true,
|
|
16339
16875
|
"locationInModule": {
|
|
16340
16876
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16341
|
-
"line":
|
|
16877
|
+
"line": 405
|
|
16342
16878
|
},
|
|
16343
16879
|
"name": "scaleInPolicy",
|
|
16344
16880
|
"optional": true,
|
|
@@ -16356,7 +16892,7 @@
|
|
|
16356
16892
|
"immutable": true,
|
|
16357
16893
|
"locationInModule": {
|
|
16358
16894
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16359
|
-
"line":
|
|
16895
|
+
"line": 320
|
|
16360
16896
|
},
|
|
16361
16897
|
"name": "sku",
|
|
16362
16898
|
"optional": true,
|
|
@@ -16373,7 +16909,7 @@
|
|
|
16373
16909
|
"immutable": true,
|
|
16374
16910
|
"locationInModule": {
|
|
16375
16911
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16376
|
-
"line":
|
|
16912
|
+
"line": 352
|
|
16377
16913
|
},
|
|
16378
16914
|
"name": "sourceImageId",
|
|
16379
16915
|
"optional": true,
|
|
@@ -16391,7 +16927,7 @@
|
|
|
16391
16927
|
"immutable": true,
|
|
16392
16928
|
"locationInModule": {
|
|
16393
16929
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16394
|
-
"line":
|
|
16930
|
+
"line": 347
|
|
16395
16931
|
},
|
|
16396
16932
|
"name": "sourceImageReference",
|
|
16397
16933
|
"optional": true,
|
|
@@ -16409,7 +16945,7 @@
|
|
|
16409
16945
|
"immutable": true,
|
|
16410
16946
|
"locationInModule": {
|
|
16411
16947
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16412
|
-
"line":
|
|
16948
|
+
"line": 369
|
|
16413
16949
|
},
|
|
16414
16950
|
"name": "subnet",
|
|
16415
16951
|
"optional": true,
|
|
@@ -16426,7 +16962,7 @@
|
|
|
16426
16962
|
"immutable": true,
|
|
16427
16963
|
"locationInModule": {
|
|
16428
16964
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16429
|
-
"line":
|
|
16965
|
+
"line": 357
|
|
16430
16966
|
},
|
|
16431
16967
|
"name": "tags",
|
|
16432
16968
|
"optional": true,
|
|
@@ -16448,7 +16984,7 @@
|
|
|
16448
16984
|
"immutable": true,
|
|
16449
16985
|
"locationInModule": {
|
|
16450
16986
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16451
|
-
"line":
|
|
16987
|
+
"line": 379
|
|
16452
16988
|
},
|
|
16453
16989
|
"name": "upgradePolicyMode",
|
|
16454
16990
|
"optional": true,
|
|
@@ -16465,7 +17001,7 @@
|
|
|
16465
17001
|
"immutable": true,
|
|
16466
17002
|
"locationInModule": {
|
|
16467
17003
|
"filename": "src/azure-virtualmachinescaleset/lib/cluster.ts",
|
|
16468
|
-
"line":
|
|
17004
|
+
"line": 335
|
|
16469
17005
|
},
|
|
16470
17006
|
"name": "zones",
|
|
16471
17007
|
"optional": true,
|
|
@@ -16490,26 +17026,38 @@
|
|
|
16490
17026
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualnetwork.Network",
|
|
16491
17027
|
"initializer": {
|
|
16492
17028
|
"docs": {
|
|
16493
|
-
"
|
|
17029
|
+
"remarks": "This class is responsible for the creation and management of a virtual network, which provides an isolated environment\nwhere Azure resources, such as VMs and databases, can securely communicate with each other, the internet, and on-premises\nnetworks. It supports configurations such as multiple address spaces and subnets, enabling complex networking scenarios.",
|
|
17030
|
+
"stability": "stable",
|
|
17031
|
+
"summary": "Represents an Azure Virtual Network (VNet) within Microsoft Azure."
|
|
16494
17032
|
},
|
|
16495
17033
|
"locationInModule": {
|
|
16496
17034
|
"filename": "src/azure-virtualnetwork/lib/network.ts",
|
|
16497
|
-
"line":
|
|
17035
|
+
"line": 94
|
|
16498
17036
|
},
|
|
16499
17037
|
"parameters": [
|
|
16500
17038
|
{
|
|
17039
|
+
"docs": {
|
|
17040
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) application."
|
|
17041
|
+
},
|
|
16501
17042
|
"name": "scope",
|
|
16502
17043
|
"type": {
|
|
16503
17044
|
"fqn": "constructs.Construct"
|
|
16504
17045
|
}
|
|
16505
17046
|
},
|
|
16506
17047
|
{
|
|
17048
|
+
"docs": {
|
|
17049
|
+
"summary": "- The unique identifier for this instance of the network, used within the scope for reference."
|
|
17050
|
+
},
|
|
16507
17051
|
"name": "id",
|
|
16508
17052
|
"type": {
|
|
16509
17053
|
"primitive": "string"
|
|
16510
17054
|
}
|
|
16511
17055
|
},
|
|
16512
17056
|
{
|
|
17057
|
+
"docs": {
|
|
17058
|
+
"remarks": "These include:\n - `resourceGroup`: The ResourceGroup within which the virtual network will be created.\n - `name`: Optional. The name of the virtual network. If not provided, a default name will be assigned.\n - `location`: Optional. The Azure region where the virtual network will be deployed. Defaults to the resource group's region.\n - `addressSpace`: Optional. A list of CIDR blocks that define the address spaces of the virtual network.\n - `subnets`: Optional. An array of subnets to be created within the virtual network, each defined by a name and a CIDR block.\n\nExample usage:\n```typescript\nconst network = new Network(this, 'MyVirtualNetwork', {\nresourceGroup: myResourceGroup,\nname: 'myVNet',\nlocation: 'West US',\naddressSpace: ['10.0.0.0/16'],\nsubnets: [{ name: 'subnet1', addressPrefixes: ['10.0.1.0/24'] }]\n});\n```\nThis class initializes a virtual network with the specified configurations and handles the provisioning of subnets\nwithin the network, providing a foundational networking layer for hosting cloud resources.",
|
|
17059
|
+
"summary": "- Configuration properties for the Azure Virtual Network, derived from the NetworkProps interface."
|
|
17060
|
+
},
|
|
16513
17061
|
"name": "props",
|
|
16514
17062
|
"type": {
|
|
16515
17063
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualnetwork.NetworkProps"
|
|
@@ -16525,21 +17073,30 @@
|
|
|
16525
17073
|
"methods": [
|
|
16526
17074
|
{
|
|
16527
17075
|
"docs": {
|
|
16528
|
-
"
|
|
17076
|
+
"remarks": "This method configures a two-way peering connection, allowing resources in both virtual networks to communicate\nseamlessly. It sets up peering settings such as network access, traffic forwarding, and gateway transit based on\nprovided configurations.",
|
|
17077
|
+
"stability": "stable",
|
|
17078
|
+
"summary": "Establishes a peering connection between this virtual network and another remote virtual network."
|
|
16529
17079
|
},
|
|
16530
17080
|
"locationInModule": {
|
|
16531
17081
|
"filename": "src/azure-virtualnetwork/lib/network.ts",
|
|
16532
|
-
"line":
|
|
17082
|
+
"line": 167
|
|
16533
17083
|
},
|
|
16534
17084
|
"name": "addVnetPeering",
|
|
16535
17085
|
"parameters": [
|
|
16536
17086
|
{
|
|
17087
|
+
"docs": {
|
|
17088
|
+
"summary": "- The remote virtual network with which to establish a peering connection."
|
|
17089
|
+
},
|
|
16537
17090
|
"name": "remoteVirtualNetwork",
|
|
16538
17091
|
"type": {
|
|
16539
17092
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualnetwork.Network"
|
|
16540
17093
|
}
|
|
16541
17094
|
},
|
|
16542
17095
|
{
|
|
17096
|
+
"docs": {
|
|
17097
|
+
"remarks": "Controls aspects like virtual network access, traffic forwarding, and use of gateways.",
|
|
17098
|
+
"summary": "- Optional settings applied from this virtual network to the remote virtual network."
|
|
17099
|
+
},
|
|
16543
17100
|
"name": "localPeerSettings",
|
|
16544
17101
|
"optional": true,
|
|
16545
17102
|
"type": {
|
|
@@ -16547,6 +17104,10 @@
|
|
|
16547
17104
|
}
|
|
16548
17105
|
},
|
|
16549
17106
|
{
|
|
17107
|
+
"docs": {
|
|
17108
|
+
"remarks": "Allows customization of how the remote network interacts with this one.\n\nExample usage:\n```typescript\n// Assuming 'this' is a reference to a local virtual network instance.\nconst partnerVNet = new Network(this, 'PartnerVNet', { ... });\nthis.addVnetPeering(partnerVNet, {\nallowVirtualNetworkAccess: true,\nallowForwardedTraffic: false,\nallowGatewayTransit: true,\nuseRemoteGateways: false\n}, {\nallowVirtualNetworkAccess: true,\nallowForwardedTraffic: true,\nallowGatewayTransit: false,\nuseRemoteGateways: false\n});\n```\nThis method invokes the `Peer` class to create a peering between 'this' virtual network and 'partnerVNet'.\nThe settings control traffic behavior and access permissions in both directions of the peering.",
|
|
17109
|
+
"summary": "- Optional settings applied from the remote virtual network to this virtual network."
|
|
17110
|
+
},
|
|
16550
17111
|
"name": "remotePeerSettings",
|
|
16551
17112
|
"optional": true,
|
|
16552
17113
|
"type": {
|
|
@@ -16776,26 +17337,38 @@
|
|
|
16776
17337
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualnetwork.Peer",
|
|
16777
17338
|
"initializer": {
|
|
16778
17339
|
"docs": {
|
|
16779
|
-
"
|
|
17340
|
+
"remarks": "This class facilitates the peering between two virtual networks, allowing resources in either network to communicate\nwith each other as if they were within the same network. It supports advanced configurations such as traffic forwarding,\ngateway transit, and access settings. This peering does not require a VPN gateway and offers low-latency, high-bandwidth\nconnections between resources in different virtual networks.",
|
|
17341
|
+
"stability": "stable",
|
|
17342
|
+
"summary": "Represents a Virtual Network Peering within Microsoft Azure."
|
|
16780
17343
|
},
|
|
16781
17344
|
"locationInModule": {
|
|
16782
17345
|
"filename": "src/azure-virtualnetwork/lib/peering.ts",
|
|
16783
|
-
"line":
|
|
17346
|
+
"line": 99
|
|
16784
17347
|
},
|
|
16785
17348
|
"parameters": [
|
|
16786
17349
|
{
|
|
17350
|
+
"docs": {
|
|
17351
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) application."
|
|
17352
|
+
},
|
|
16787
17353
|
"name": "scope",
|
|
16788
17354
|
"type": {
|
|
16789
17355
|
"fqn": "constructs.Construct"
|
|
16790
17356
|
}
|
|
16791
17357
|
},
|
|
16792
17358
|
{
|
|
17359
|
+
"docs": {
|
|
17360
|
+
"summary": "- The unique name for this instance of the network peering."
|
|
17361
|
+
},
|
|
16793
17362
|
"name": "name",
|
|
16794
17363
|
"type": {
|
|
16795
17364
|
"primitive": "string"
|
|
16796
17365
|
}
|
|
16797
17366
|
},
|
|
16798
17367
|
{
|
|
17368
|
+
"docs": {
|
|
17369
|
+
"remarks": "These include:\n - `virtualNetwork`: The local virtual network object.\n - `remoteVirtualNetwork`: The remote virtual network object.\n - `localToRemoteSettings`: Configuration settings applied from the local virtual network to the remote virtual network.\n - `remoteToLocalSettings`: Configuration settings applied from the remote virtual network to the local virtual network.\n\nExample usage:\n```typescript\nconst vnetPeering = new Peer(this, 'VNetPeering', {\nvirtualNetwork: myVNet,\nremoteVirtualNetwork: partnerVNet,\nlocalToRemoteSettings: {\nallowVirtualNetworkAccess: true,\nallowForwardedTraffic: false,\nallowGatewayTransit: false,\nuseRemoteGateways: false\n},\nremoteToLocalSettings: {\nallowVirtualNetworkAccess: true,\nallowForwardedTraffic: true,\nallowGatewayTransit: false,\nuseRemoteGateways: false\n}\n});\n```\nThis class initializes a VNet peering with the specified configurations, enabling direct connectivity between\nthe specified virtual networks. It manages the creation and configuration of network peering settings, ensuring\nthat both VNets are appropriately linked and configured according to the defined properties.",
|
|
17370
|
+
"summary": "- Configuration properties for the network peering, derived from the PeerProps interface."
|
|
17371
|
+
},
|
|
16799
17372
|
"name": "props",
|
|
16800
17373
|
"type": {
|
|
16801
17374
|
"fqn": "@microsoft/terraform-cdk-constructs.azure_virtualnetwork.PeerProps"
|
|
@@ -17085,21 +17658,30 @@
|
|
|
17085
17658
|
"methods": [
|
|
17086
17659
|
{
|
|
17087
17660
|
"docs": {
|
|
17088
|
-
"
|
|
17661
|
+
"remarks": "This method creates a new role assignment which grants the specified Azure AD object access to resources\nat the scope defined by this construct. This is useful for programmatically managing access controls,\nensuring only authorized users or systems can perform specific actions on Azure resources.",
|
|
17662
|
+
"stability": "stable",
|
|
17663
|
+
"summary": "Adds an access role assignment for a specified Azure AD object (e.g., user, group, service principal) within this RBAC construct's scope."
|
|
17089
17664
|
},
|
|
17090
17665
|
"locationInModule": {
|
|
17091
17666
|
"filename": "src/core-azure/lib/resource.ts",
|
|
17092
|
-
"line":
|
|
17667
|
+
"line": 36
|
|
17093
17668
|
},
|
|
17094
17669
|
"name": "addAccess",
|
|
17095
17670
|
"parameters": [
|
|
17096
17671
|
{
|
|
17672
|
+
"docs": {
|
|
17673
|
+
"summary": "- The unique identifier of the Azure AD object (user, group, or service principal) that will receive the role assignment."
|
|
17674
|
+
},
|
|
17097
17675
|
"name": "objectId",
|
|
17098
17676
|
"type": {
|
|
17099
17677
|
"primitive": "string"
|
|
17100
17678
|
}
|
|
17101
17679
|
},
|
|
17102
17680
|
{
|
|
17681
|
+
"docs": {
|
|
17682
|
+
"remarks": "This role defines the permissions that the object will have.\n\nExample usage:\n```typescript\n// Example: Assign a \"Reader\" role to a user for the current RBAC scope\nrbacInstance.addAccess('user-object-id', 'Reader');\n```",
|
|
17683
|
+
"summary": "- The human-readable name of the Azure RBAC role to be assigned."
|
|
17684
|
+
},
|
|
17103
17685
|
"name": "customRoleName",
|
|
17104
17686
|
"type": {
|
|
17105
17687
|
"primitive": "string"
|
|
@@ -17109,15 +17691,22 @@
|
|
|
17109
17691
|
},
|
|
17110
17692
|
{
|
|
17111
17693
|
"docs": {
|
|
17112
|
-
"
|
|
17694
|
+
"remarks": "This method creates and configures a new DiagnosticSettings instance which captures and routes\ndiagnostic data (logs and metrics) to the specified destinations such as Azure Monitor,\nan Event Hubs instance, a Log Analytics workspace, or an Azure Storage account.",
|
|
17695
|
+
"returns": "An instance of the DiagnosticSettings class, configured with the provided properties.\n\nExample usage:\n```typescript\nconst diagSettings = resource.addDiagSettings({\nname: 'custom-diag-settings',\nlogAnalyticsWorkspaceId: 'workspace-id',\neventhubAuthorizationRuleId: 'auth-rule-id',\neventhubName: 'eventhub-name',\nstorageAccountId: 'storage-account-id'\n});\n```",
|
|
17696
|
+
"stability": "stable",
|
|
17697
|
+
"summary": "Adds diagnostic settings to a specified resource within this construct."
|
|
17113
17698
|
},
|
|
17114
17699
|
"locationInModule": {
|
|
17115
17700
|
"filename": "src/core-azure/lib/resource.ts",
|
|
17116
|
-
"line":
|
|
17701
|
+
"line": 73
|
|
17117
17702
|
},
|
|
17118
17703
|
"name": "addDiagSettings",
|
|
17119
17704
|
"parameters": [
|
|
17120
17705
|
{
|
|
17706
|
+
"docs": {
|
|
17707
|
+
"remarks": "These include:\n - `name`: Optional. The name of the diagnostic settings resource. Defaults to 'diag-settings'.\n - `logAnalyticsWorkspaceId`: Optional. The identifier of the Log Analytics workspace to send logs.\n - `eventhubAuthorizationRuleId`: Optional. The authorization rule ID for an Event Hub where logs will be forwarded.\n - `eventhubName`: Optional. The name of the Event Hub to which logs will be sent.\n - `storageAccountId`: Optional. The identifier of the Azure Storage account where logs will be stored.\n - `logAnalyticsDestinationType`: Optional. Determines if logs are sent to dedicated or legacy tables in Log Analytics. Defaults to undefined which uses the default settings.\n The `targetResourceId` is automatically set to the ID of this construct instance.",
|
|
17708
|
+
"summary": "- The properties required to configure the diagnostic settings."
|
|
17709
|
+
},
|
|
17121
17710
|
"name": "props",
|
|
17122
17711
|
"type": {
|
|
17123
17712
|
"fqn": "@microsoft/terraform-cdk-constructs.core_azure.BaseDiagnosticSettingsProps"
|
|
@@ -17136,7 +17725,7 @@
|
|
|
17136
17725
|
},
|
|
17137
17726
|
"locationInModule": {
|
|
17138
17727
|
"filename": "src/core-azure/lib/resource.ts",
|
|
17139
|
-
"line":
|
|
17728
|
+
"line": 87
|
|
17140
17729
|
},
|
|
17141
17730
|
"name": "setupResourceGroup",
|
|
17142
17731
|
"parameters": [
|
|
@@ -17222,7 +17811,7 @@
|
|
|
17222
17811
|
"kind": "class",
|
|
17223
17812
|
"locationInModule": {
|
|
17224
17813
|
"filename": "src/core-azure/lib/resource.ts",
|
|
17225
|
-
"line":
|
|
17814
|
+
"line": 104
|
|
17226
17815
|
},
|
|
17227
17816
|
"methods": [
|
|
17228
17817
|
{
|
|
@@ -17231,7 +17820,7 @@
|
|
|
17231
17820
|
},
|
|
17232
17821
|
"locationInModule": {
|
|
17233
17822
|
"filename": "src/core-azure/lib/resource.ts",
|
|
17234
|
-
"line":
|
|
17823
|
+
"line": 112
|
|
17235
17824
|
},
|
|
17236
17825
|
"name": "addMetricAlert",
|
|
17237
17826
|
"parameters": [
|
|
@@ -17249,7 +17838,7 @@
|
|
|
17249
17838
|
},
|
|
17250
17839
|
"locationInModule": {
|
|
17251
17840
|
"filename": "src/core-azure/lib/resource.ts",
|
|
17252
|
-
"line":
|
|
17841
|
+
"line": 105
|
|
17253
17842
|
},
|
|
17254
17843
|
"name": "addQueryRuleAlert",
|
|
17255
17844
|
"parameters": [
|
|
@@ -17458,26 +18047,38 @@
|
|
|
17458
18047
|
"fqn": "@microsoft/terraform-cdk-constructs.core_azure.DiagnosticSettings",
|
|
17459
18048
|
"initializer": {
|
|
17460
18049
|
"docs": {
|
|
17461
|
-
"
|
|
18050
|
+
"remarks": "This class is responsible for configuring Azure Monitor Diagnostic Settings to collect and route metrics and logs from\nAzure resources to monitoring and analytics services. Diagnostic settings can be applied to resources like VMs,\nApp Services, and more, allowing collected data to be sent to Event Hubs, Log Analytics workspaces, or Azure Storage.",
|
|
18051
|
+
"stability": "stable",
|
|
18052
|
+
"summary": "Manages the diagnostic settings for monitoring Azure resources."
|
|
17462
18053
|
},
|
|
17463
18054
|
"locationInModule": {
|
|
17464
18055
|
"filename": "src/core-azure/lib/diagsettings.ts",
|
|
17465
|
-
"line":
|
|
18056
|
+
"line": 96
|
|
17466
18057
|
},
|
|
17467
18058
|
"parameters": [
|
|
17468
18059
|
{
|
|
18060
|
+
"docs": {
|
|
18061
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
18062
|
+
},
|
|
17469
18063
|
"name": "scope",
|
|
17470
18064
|
"type": {
|
|
17471
18065
|
"fqn": "constructs.Construct"
|
|
17472
18066
|
}
|
|
17473
18067
|
},
|
|
17474
18068
|
{
|
|
18069
|
+
"docs": {
|
|
18070
|
+
"summary": "- The unique identifier for this instance of the diagnostic settings."
|
|
18071
|
+
},
|
|
17475
18072
|
"name": "id",
|
|
17476
18073
|
"type": {
|
|
17477
18074
|
"primitive": "string"
|
|
17478
18075
|
}
|
|
17479
18076
|
},
|
|
17480
18077
|
{
|
|
18078
|
+
"docs": {
|
|
18079
|
+
"remarks": "These properties include:\n - `name`: Optional. The name of the diagnostic settings. If not provided, a unique name will be generated.\n - `targetResourceId`: The ID of the Azure resource to which these diagnostic settings apply.\n - `storageAccountId`: Optional. The ID of the Azure Storage account to which logs and metrics are sent.\n - `eventhubAuthorizationRuleId`: Optional. The authorization rule ID for the Event Hub namespace.\n - `eventhubName`: Optional. The name of the Event Hub where metrics and logs will be sent.\n - `logAnalyticsWorkspaceId`: Optional. The ID of the Log Analytics workspace to which logs and metrics are sent.\n - `partnerSolutionId`: Optional. ID of a partner solution that configurations are fetched from.\n - `logCategories`: Optional. Categories of logs to collect.\n - `metricCategories`: Optional. Categories of metrics to collect.\n - `logAnalyticsDestinationType`: Optional. Specifies whether logs should be stored in a dedicated table or the\n legacy AzureDiagnostics table in the Log Analytics workspace.\n\nExample usage:\n```typescript\nconst resourceGroup = new ResourceGroup(this, 'ResourceGroup', { ... });\nconst diagnostics = new DiagnosticSettings(this, 'MyDiagnostics', {\nname: 'example-diagnostics',\ntargetResourceId: resourceGroup.id,\nlogAnalyticsWorkspaceId: logAnalyticsWorkspace.id,\nstorageAccountId: storageAccount.id,\nlogCategories: ['Write', 'Delete'],\nmetricCategories: ['AllMetrics']\n});\n```\nThis class configures the diagnostic settings to collect specific logs and metrics from the target resource and routes them\nto specified destinations such as Log Analytics, Storage Account, or Event Hubs.",
|
|
18080
|
+
"summary": "- Configuration properties for diagnostic settings."
|
|
18081
|
+
},
|
|
17481
18082
|
"name": "props",
|
|
17482
18083
|
"type": {
|
|
17483
18084
|
"fqn": "@microsoft/terraform-cdk-constructs.core_azure.DiagnosticSettingsProps"
|
|
@@ -17556,17 +18157,18 @@
|
|
|
17556
18157
|
"fqn": "@microsoft/terraform-cdk-constructs.core_azure.Rbac",
|
|
17557
18158
|
"initializer": {
|
|
17558
18159
|
"docs": {
|
|
18160
|
+
"remarks": "This class is responsible for creating and managing RBAC role assignments in Azure, which control permissions for Azure AD\nidentities to manage Azure resources. It supports assigning roles at different scopes such as subscriptions, resource groups,\nor specific resources.",
|
|
17559
18161
|
"stability": "stable",
|
|
17560
|
-
"summary": "
|
|
18162
|
+
"summary": "Manages Role-Based Access Control (RBAC) assignments within Azure."
|
|
17561
18163
|
},
|
|
17562
18164
|
"locationInModule": {
|
|
17563
18165
|
"filename": "src/core-azure/lib/rbac.ts",
|
|
17564
|
-
"line":
|
|
18166
|
+
"line": 55
|
|
17565
18167
|
},
|
|
17566
18168
|
"parameters": [
|
|
17567
18169
|
{
|
|
17568
18170
|
"docs": {
|
|
17569
|
-
"summary": "- The scope in which this construct
|
|
18171
|
+
"summary": "- The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack."
|
|
17570
18172
|
},
|
|
17571
18173
|
"name": "scope",
|
|
17572
18174
|
"type": {
|
|
@@ -17575,7 +18177,7 @@
|
|
|
17575
18177
|
},
|
|
17576
18178
|
{
|
|
17577
18179
|
"docs": {
|
|
17578
|
-
"summary": "- The
|
|
18180
|
+
"summary": "- The unique identifier for this instance of the RBAC assignment."
|
|
17579
18181
|
},
|
|
17580
18182
|
"name": "id",
|
|
17581
18183
|
"type": {
|
|
@@ -17584,7 +18186,8 @@
|
|
|
17584
18186
|
},
|
|
17585
18187
|
{
|
|
17586
18188
|
"docs": {
|
|
17587
|
-
"
|
|
18189
|
+
"remarks": "These properties include:\n - `objectId`: The Azure AD object ID for the user, group, or service principal to which the role is assigned.\n - `roleDefinitionUUID`: Optional. The UUID of the Azure RBAC role definition. This can be obtained via Azure CLI.\n - `roleDefinitionName`: The name of the role to be assigned, such as 'Contributor', 'Reader', or 'Owner'.\n - `scope`: The scope at which the role is assigned, which could be a subscription, resource group, or specific resource.\n\nExample usage:\n```typescript\nconst rbac = new Rbac(this, 'rbacAssignment', {\nobjectId: 'user-or-group-object-id',\nroleDefinitionName: 'Contributor',\nscope: '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}'\n});\n```\nThis RBAC instance assigns the 'Contributor' role to a user or group specified by 'objectId' at the scope of a specific resource group.",
|
|
18190
|
+
"summary": "- Configuration properties for the RBAC assignment."
|
|
17588
18191
|
},
|
|
17589
18192
|
"name": "props",
|
|
17590
18193
|
"type": {
|
|
@@ -17688,6 +18291,6 @@
|
|
|
17688
18291
|
"symbolId": "src/core-azure/lib/rbac:RbacProps"
|
|
17689
18292
|
}
|
|
17690
18293
|
},
|
|
17691
|
-
"version": "0.0.3-pre.
|
|
17692
|
-
"fingerprint": "
|
|
18294
|
+
"version": "0.0.3-pre.7",
|
|
18295
|
+
"fingerprint": "PShCliXIIPYsGbSPKZOFWQWTYMWMRqjZf4tXsrfJZYk="
|
|
17693
18296
|
}
|