From 8e54b196ceeb60c4e0a90bc7d897b0cdf9b2beff Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Mon, 3 Jun 2024 08:43:30 -0700 Subject: [PATCH] Add new resources before 11.7 (#209) These shipped this morning Signed-off-by: Tim Smith --- .../resources/aws-pack/aws.eks.nodegroup.md | 32 ++++++++++--------- ...rvice.instance.settings.ipconfiguration.md | 18 ++++++----- docs/mql/resources/os-pack/README.md | 4 ++- docs/mql/resources/os-pack/windows.feature.md | 8 ++--- docs/mql/resources/os-pack/windows.md | 14 ++++---- .../os-pack/windows.optionalfeature.md | 27 ++++++++++++++++ .../os-pack/windows.serverfeature.md | 28 ++++++++++++++++ 7 files changed, 97 insertions(+), 34 deletions(-) create mode 100644 docs/mql/resources/os-pack/windows.optionalfeature.md create mode 100644 docs/mql/resources/os-pack/windows.serverfeature.md diff --git a/docs/mql/resources/aws-pack/aws.eks.nodegroup.md b/docs/mql/resources/aws-pack/aws.eks.nodegroup.md index 4d26bc00..ef433d65 100644 --- a/docs/mql/resources/aws-pack/aws.eks.nodegroup.md +++ b/docs/mql/resources/aws-pack/aws.eks.nodegroup.md @@ -18,18 +18,20 @@ Amazon EKS managed node group **Fields** -| ID | TYPE | DESCRIPTION | -| ------------- | ------------------------------- | ------------------------------------------------------ | -| name | string | Name for the EKS node group | -| arn | string | ARN for the EKS node group | -| region | string | Region for the EKS node group | -| createdAt | time | Time when the EKS node group was created | -| status | string | Status for the EKS node group | -| capacityType | string | Capacity type for the EKS node group (ON_DEMAND, SPOT) | -| scalingConfig | dict | Scaling configuration for the EKS node group | -| instanceTypes | []string | Instance types for the EKS node group | -| amiType | string | AMI type for the EKS node group | -| nodeRole | [aws.iam.role](aws.iam.role.md) | IAM role for the EKS node group | -| diskSize | int | Disk size for the EKS node group | -| labels | map[string]string | Kubernetes labels applied to the EKS node group | -| tags | map[string]string | Tags for the EKS node group | +| ID | TYPE | DESCRIPTION | +| ----------------- | ----------------------------------------------------------- | ------------------------------------------------------ | +| name | string | Name for the EKS node group | +| arn | string | ARN for the EKS node group | +| region | string | Region for the EKS node group | +| createdAt | time | Time when the EKS node group was created | +| modifiedAt | time | Time when the EKS node group was last modified | +| status | string | Status for the EKS node group | +| capacityType | string | Capacity type for the EKS node group (ON_DEMAND, SPOT) | +| scalingConfig | dict | Scaling configuration for the EKS node group | +| instanceTypes | []string | Instance types for the EKS node group | +| amiType | string | AMI type for the EKS node group | +| nodeRole | [aws.iam.role](aws.iam.role.md) | IAM role for the EKS node group | +| diskSize | int | Disk size for the EKS node group | +| labels | map[string]string | Kubernetes labels applied to the EKS node group | +| tags | map[string]string | Tags for the EKS node group | +| autoscalingGroups | [][aws.autoscaling.group](aws.autoscaling.group.md) | List of autoscaling groups for the node group | diff --git a/docs/mql/resources/gcp-pack/gcp.project.sqlservice.instance.settings.ipconfiguration.md b/docs/mql/resources/gcp-pack/gcp.project.sqlservice.instance.settings.ipconfiguration.md index 6f701c07..b333fb55 100644 --- a/docs/mql/resources/gcp-pack/gcp.project.sqlservice.instance.settings.ipconfiguration.md +++ b/docs/mql/resources/gcp-pack/gcp.project.sqlservice.instance.settings.ipconfiguration.md @@ -18,11 +18,13 @@ Google Cloud (GCP) SQL instance settings IP configuration **Fields** -| ID | TYPE | DESCRIPTION | -| ------------------ | -------------- | ---------------------------------------------------------------------------------------------- | -| id | string | Internal ID | -| allocatedIpRange | string | Name of the allocated IP range for the private IP Cloud SQL instance | -| authorizedNetworks | []dict | List of external networks that are allowed to connect to the instance using the IP | -| ipv4Enabled | bool | Whether the instance is assigned a public IP address | -| privateNetwork | string | Resource link for the VPC network from which the private IPs can access the Cloud SQL instance | -| requireSsl | bool | Whether SSL connections over IP are enforced | +| ID | TYPE | DESCRIPTION | +| --------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------- | +| id | string | Internal ID | +| allocatedIpRange | string | Name of the allocated IP range for the private IP Cloud SQL instance | +| authorizedNetworks | []dict | List of external networks that are allowed to connect to the instance using the IP | +| ipv4Enabled | bool | Whether the instance is assigned a public IP address | +| privateNetwork | string | Resource link for the VPC network from which the private IPs can access the Cloud SQL instance | +| requireSsl | bool | Whether SSL connections over IP are enforced | +| sslMode | string | Specifies how SSL/TLS is enforced in database connections. | +| enablePrivatePathForGoogleCloudServices | bool | Controls connectivity to private IP instances from Google services, such as BigQuery. | diff --git a/docs/mql/resources/os-pack/README.md b/docs/mql/resources/os-pack/README.md index a5dfa229..11643fbb 100644 --- a/docs/mql/resources/os-pack/README.md +++ b/docs/mql/resources/os-pack/README.md @@ -116,13 +116,15 @@ Resources included in this pack: | [windows](windows.md) | Windows-specific resource to get operating system details | | [windows.bitlocker](windows.bitlocker.md) | Windows BitLocker | | [windows.bitlocker.volume](windows.bitlocker.volume.md) | Windows BitLocker volume | -| [windows.feature](windows.feature.md) | Windows feature resource | +| [windows.feature](windows.feature.md) | Deprecated: use serverFeature instead | | [windows.firewall](windows.firewall.md) | Windows Firewall resource | | [windows.firewall.profile](windows.firewall.profile.md) | Windows Firewall profile entry | | [windows.firewall.rule](windows.firewall.rule.md) | Windows Firewall rule entry | | [windows.hotfix](windows.hotfix.md) | Windows hotfix resource | +| [windows.optionalFeature](windows.optionalfeature.md) | Windows optional feature resource | | [windows.security](windows.security.md) | | | [windows.security.health](windows.security.health.md) | Health of the Windows security provider | | [windows.security.product](windows.security.product.md) | Private Windows security product | +| [windows.serverFeature](windows.serverfeature.md) | Windows Server feature resource | | [yum](yum.md) | Yum package manager resource | | [yum.repo](yum.repo.md) | Yum repository resource | diff --git a/docs/mql/resources/os-pack/windows.feature.md b/docs/mql/resources/os-pack/windows.feature.md index 8c808011..4d284a36 100644 --- a/docs/mql/resources/os-pack/windows.feature.md +++ b/docs/mql/resources/os-pack/windows.feature.md @@ -3,14 +3,14 @@ title: windows.feature id: windows.feature sidebar_label: windows.feature displayed_sidebar: MQL -description: Windows feature resource +description: Deprecated use serverFeature instead --- # windows.feature **Description** -Windows feature resource +Deprecated: use serverFeature instead **Init** @@ -31,12 +31,12 @@ windows.feature(name string) Check that a Windows features is installed -```coffeescript +```coffee windows.feature('SNMP-Service').installed ``` Check that a specific feature is not installed -```coffeescript +```coffee windows.feature('Windows-Defender').installed == false ``` diff --git a/docs/mql/resources/os-pack/windows.md b/docs/mql/resources/os-pack/windows.md index 094701c1..4e6c71f3 100644 --- a/docs/mql/resources/os-pack/windows.md +++ b/docs/mql/resources/os-pack/windows.md @@ -14,16 +14,18 @@ Windows-specific resource to get operating system details **Fields** -| ID | TYPE | DESCRIPTION | -| ------------ | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| computerInfo | dict | A consolidated object of system and operating system properties, see https://docs.microsoft.com/en-us/dotnet/api/microsoft.powershell.commands.computerinfo?view=powershellsdk-1.1.0 for more information | -| hotfixes | [][windows.hotfix](windows.hotfix.md) | Hotfixes installed on the computer | -| features | [][windows.feature](windows.feature.md) | Information about Windows Server roles, role services, and features that are available for installation and installed on a specified server. | +| ID | TYPE | DESCRIPTION | +| ---------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| computerInfo | dict | A consolidated object of system and operating system properties, see https://docs.microsoft.com/en-us/dotnet/api/microsoft.powershell.commands.computerinfo?view=powershellsdk-1.1.0 for more information | +| hotfixes | [][windows.hotfix](windows.hotfix.md) | Hotfixes installed on the computer | +| features | [][windows.feature](windows.feature.md) | Deprecated: use serverFeatures instead | +| serverFeatures | [][windows.serverFeature](windows.serverfeature.md) | Information about Windows Server roles, role services, and features that are available for installation and installed on a specified server. | +| optionalFeatures | [][windows.optionalFeature](windows.optionalfeature.md) | Information about optional features in a Windows image. | **Examples** Check the OS Edition -```coffeescript +```coffee windows.computerInfo['WindowsInstallationType'] == 'Server Core' ``` diff --git a/docs/mql/resources/os-pack/windows.optionalfeature.md b/docs/mql/resources/os-pack/windows.optionalfeature.md new file mode 100644 index 00000000..f7678d10 --- /dev/null +++ b/docs/mql/resources/os-pack/windows.optionalfeature.md @@ -0,0 +1,27 @@ +--- +title: windows.optionalFeature +id: windows.optionalFeature +sidebar_label: windows.optionalFeature +displayed_sidebar: MQL +description: Windows optional feature resource +--- + +# windows.optionalFeature + +**Description** + +Windows optional feature resource + +**Init** + +windows.optionalFeature(name string) + +**Fields** + +| ID | TYPE | DESCRIPTION | +| ----------- | ------ | ------------------------------ | +| name | string | Command ID of optional feature | +| displayName | string | Feature name | +| description | string | Feature description | +| enabled | bool | Whether the feature is enabled | +| state | int | Feature installation state | diff --git a/docs/mql/resources/os-pack/windows.serverfeature.md b/docs/mql/resources/os-pack/windows.serverfeature.md new file mode 100644 index 00000000..98a011fd --- /dev/null +++ b/docs/mql/resources/os-pack/windows.serverfeature.md @@ -0,0 +1,28 @@ +--- +title: windows.serverFeature +id: windows.serverFeature +sidebar_label: windows.serverFeature +displayed_sidebar: MQL +description: Windows Server feature resource +--- + +# windows.serverFeature + +**Description** + +Windows Server feature resource + +**Init** + +windows.serverFeature(name string) + +**Fields** + +| ID | TYPE | DESCRIPTION | +| ------------ | ------ | --------------------------------------------- | +| path | string | Feature full path | +| name | string | Command IDs of role, role service, or feature | +| displayName | string | Feature name | +| description | string | Feature description | +| installed | bool | Whether the feature is installed | +| installState | int | Feature installation state |