com.azure.resourcemanager.security.models.Extension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-security Show documentation
This package contains Microsoft Azure SDK for Security Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. API spec for Microsoft.Security (Azure Security Center) resource provider. Package tag package-composite-v3.
There is a newer version: 1.0.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.security.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.util.logging.ClientLogger;
import com.azure.json.JsonReader;
import com.azure.json.JsonSerializable;
import com.azure.json.JsonToken;
import com.azure.json.JsonWriter;
import java.io.IOException;
import java.util.Map;

/**
 * A plan's extension properties.
 */
@Fluent
public final class Extension implements JsonSerializable {
    /*
     * The extension name. Supported values are: 

**AgentlessDiscoveryForKubernetes** - Provides zero footprint,
     * API-based discovery of Kubernetes clusters, their configurations and deployments. The collected data is used to
     * create a contextualized security graph for Kubernetes clusters, provide risk hunting capabilities, and visualize
     * risks and threats to Kubernetes environments and workloads.
Available for CloudPosture plan and Containers
     * plan.

**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage account within
     * the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current
     * calendar month.
Available for StorageAccounts plan (DefenderForStorageV2 sub
     * plans).

**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage container with
     * sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security
     * events.
Available for StorageAccounts plan (DefenderForStorageV2 sub plan) and CloudPosture
     * plan.

**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for images
     * stored in your container registries.
Available for CloudPosture plan and Containers
     * plan.

**MdeDesignatedSubscription** - Direct onboarding is a seamless integration between Defender for
     * Endpoint and Defender for Cloud that doesn’t require extra software deployment on your servers. The onboarded
     * resources will be presented under a designated Azure Subscription you configure
Available for VirtualMachines
     * plan (P1 and P2 sub plans).

**AgentlessVmScanning** - Scans your machines for installed software,
     * vulnerabilities, malware and secret scanning without relying on agents or impacting machine performance. Learn
     * more here
     * https://learn.microsoft.com/en-us/azure/defender-for-cloud/concept-agentless-data-collection.
Available for
     * CloudPosture plan, VirtualMachines plan (P2 sub plan) and Containers plan.

**EntraPermissionsManagement**
     * - Permissions Management provides Cloud Infrastructure Entitlement Management (CIEM) capabilities that helps
     * organizations to manage and control user access and entitlements in their cloud infrastructure - important attack
     * vector for cloud environments.
Permissions Management analyzes all permissions and active usage, and suggests
     * recommendations to reduce permissions to enforce the principle of least privilege. Learn more here
     * https://learn.microsoft.com/en-us/azure/defender-for-cloud/permissions-management.
Available for CloudPosture
     * plan. 

**FileIntegrityMonitoring** - File integrity monitoring (FIM), examines operating system
     * files.
Windows registries, Linux system files, in real time, for changes that might indicate an
     * attack.
Available for VirtualMachines plan (P2 sub plan). 

**ContainerSensor** - The sensor is based on
     * IG and provides a rich threat detection suite for Kubernetes clusters, nodes, and workloads, powered by Microsoft
     * leading threat intelligence, provides mapping to MITRE ATT&CK framework.
Available for Containers plan.
     * 

**AIPromptEvidence** - Exposes the prompts passed between the user and the AI model as alert evidence.
     * This helps classify and triage the alerts with relevant user context. The prompt snippets will include only
     * segments of the user prompt or model response that were deemed suspicious and relevant for security
     * classifications. The prompt evidence will be available through Defender portal as part of each
     * alert.
Available for AI plan. 


     */
    private String name;

    /*
     * Indicates whether the extension is enabled.
     */
    private IsEnabled isEnabled;

    /*
     * Property values associated with the extension.
     */
    private Map additionalExtensionProperties;

    /*
     * Optional. A status describing the success/failure of the extension's enablement/disablement operation.
     */
    private OperationStatusAutoGenerated operationStatus;

    /**
     * Creates an instance of Extension class.
     */
    public Extension() {
    }

    /**
     * Get the name property: The extension name. Supported values are:
     * <br><br>**AgentlessDiscoveryForKubernetes** - Provides zero footprint, API-based discovery of
     * Kubernetes clusters, their configurations and deployments. The collected data is used to create a contextualized
     * security graph for Kubernetes clusters, provide risk hunting capabilities, and visualize risks and threats to
     * Kubernetes environments and workloads.<br>Available for CloudPosture plan and Containers
     * plan.<br><br>**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage
     * account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned
     * during current calendar month.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub
     * plans).<br><br>**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage
     * container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate
     * security events.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub plan) and CloudPosture
     * plan.<br><br>**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for
     * images stored in your container registries.<br>Available for CloudPosture plan and Containers
     * plan.<br><br>**MdeDesignatedSubscription** - Direct onboarding is a seamless integration between
     * Defender for Endpoint and Defender for Cloud that doesn’t require extra software deployment on your servers. The
     * onboarded resources will be presented under a designated Azure Subscription you configure<br>Available for
     * VirtualMachines plan (P1 and P2 sub plans).<br><br>**AgentlessVmScanning** - Scans your machines for
     * installed software, vulnerabilities, malware and secret scanning without relying on agents or impacting machine
     * performance. Learn more here
     * https://learn.microsoft.com/en-us/azure/defender-for-cloud/concept-agentless-data-collection.<br>Available
     * for CloudPosture plan, VirtualMachines plan (P2 sub plan) and Containers
     * plan.<br><br>**EntraPermissionsManagement** - Permissions Management provides Cloud Infrastructure
     * Entitlement Management (CIEM) capabilities that helps organizations to manage and control user access and
     * entitlements in their cloud infrastructure - important attack vector for cloud environments.<br>Permissions
     * Management analyzes all permissions and active usage, and suggests recommendations to reduce permissions to
     * enforce the principle of least privilege. Learn more here
     * https://learn.microsoft.com/en-us/azure/defender-for-cloud/permissions-management.<br>Available for
     * CloudPosture plan. <br><br>**FileIntegrityMonitoring** - File integrity monitoring (FIM), examines
     * operating system files.<br>Windows registries, Linux system files, in real time, for changes that might
     * indicate an attack.<br>Available for VirtualMachines plan (P2 sub plan).
     * <br><br>**ContainerSensor** - The sensor is based on IG and provides a rich threat detection suite
     * for Kubernetes clusters, nodes, and workloads, powered by Microsoft leading threat intelligence, provides mapping
     * to MITRE ATT&CK framework.<br>Available for Containers plan. <br><br>**AIPromptEvidence** -
     * Exposes the prompts passed between the user and the AI model as alert evidence. This helps classify and triage
     * the alerts with relevant user context. The prompt snippets will include only segments of the user prompt or model
     * response that were deemed suspicious and relevant for security classifications. The prompt evidence will be
     * available through Defender portal as part of each alert.<br>Available for AI plan. <br><br>.
     * 
     * @return the name value.
     */
    public String name() {
        return this.name;
    }

    /**
     * Set the name property: The extension name. Supported values are:
     * <br><br>**AgentlessDiscoveryForKubernetes** - Provides zero footprint, API-based discovery of
     * Kubernetes clusters, their configurations and deployments. The collected data is used to create a contextualized
     * security graph for Kubernetes clusters, provide risk hunting capabilities, and visualize risks and threats to
     * Kubernetes environments and workloads.<br>Available for CloudPosture plan and Containers
     * plan.<br><br>**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage
     * account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned
     * during current calendar month.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub
     * plans).<br><br>**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage
     * container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate
     * security events.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub plan) and CloudPosture
     * plan.<br><br>**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for
     * images stored in your container registries.<br>Available for CloudPosture plan and Containers
     * plan.<br><br>**MdeDesignatedSubscription** - Direct onboarding is a seamless integration between
     * Defender for Endpoint and Defender for Cloud that doesn’t require extra software deployment on your servers. The
     * onboarded resources will be presented under a designated Azure Subscription you configure<br>Available for
     * VirtualMachines plan (P1 and P2 sub plans).<br><br>**AgentlessVmScanning** - Scans your machines for
     * installed software, vulnerabilities, malware and secret scanning without relying on agents or impacting machine
     * performance. Learn more here
     * https://learn.microsoft.com/en-us/azure/defender-for-cloud/concept-agentless-data-collection.<br>Available
     * for CloudPosture plan, VirtualMachines plan (P2 sub plan) and Containers
     * plan.<br><br>**EntraPermissionsManagement** - Permissions Management provides Cloud Infrastructure
     * Entitlement Management (CIEM) capabilities that helps organizations to manage and control user access and
     * entitlements in their cloud infrastructure - important attack vector for cloud environments.<br>Permissions
     * Management analyzes all permissions and active usage, and suggests recommendations to reduce permissions to
     * enforce the principle of least privilege. Learn more here
     * https://learn.microsoft.com/en-us/azure/defender-for-cloud/permissions-management.<br>Available for
     * CloudPosture plan. <br><br>**FileIntegrityMonitoring** - File integrity monitoring (FIM), examines
     * operating system files.<br>Windows registries, Linux system files, in real time, for changes that might
     * indicate an attack.<br>Available for VirtualMachines plan (P2 sub plan).
     * <br><br>**ContainerSensor** - The sensor is based on IG and provides a rich threat detection suite
     * for Kubernetes clusters, nodes, and workloads, powered by Microsoft leading threat intelligence, provides mapping
     * to MITRE ATT&CK framework.<br>Available for Containers plan. <br><br>**AIPromptEvidence** -
     * Exposes the prompts passed between the user and the AI model as alert evidence. This helps classify and triage
     * the alerts with relevant user context. The prompt snippets will include only segments of the user prompt or model
     * response that were deemed suspicious and relevant for security classifications. The prompt evidence will be
     * available through Defender portal as part of each alert.<br>Available for AI plan. <br><br>.
     * 
     * @param name the name value to set.
     * @return the Extension object itself.
     */
    public Extension withName(String name) {
        this.name = name;
        return this;
    }

    /**
     * Get the isEnabled property: Indicates whether the extension is enabled.
     * 
     * @return the isEnabled value.
     */
    public IsEnabled isEnabled() {
        return this.isEnabled;
    }

    /**
     * Set the isEnabled property: Indicates whether the extension is enabled.
     * 
     * @param isEnabled the isEnabled value to set.
     * @return the Extension object itself.
     */
    public Extension withIsEnabled(IsEnabled isEnabled) {
        this.isEnabled = isEnabled;
        return this;
    }

    /**
     * Get the additionalExtensionProperties property: Property values associated with the extension.
     * 
     * @return the additionalExtensionProperties value.
     */
    public Map additionalExtensionProperties() {
        return this.additionalExtensionProperties;
    }

    /**
     * Set the additionalExtensionProperties property: Property values associated with the extension.
     * 
     * @param additionalExtensionProperties the additionalExtensionProperties value to set.
     * @return the Extension object itself.
     */
    public Extension withAdditionalExtensionProperties(Map additionalExtensionProperties) {
        this.additionalExtensionProperties = additionalExtensionProperties;
        return this;
    }

    /**
     * Get the operationStatus property: Optional. A status describing the success/failure of the extension's
     * enablement/disablement operation.
     * 
     * @return the operationStatus value.
     */
    public OperationStatusAutoGenerated operationStatus() {
        return this.operationStatus;
    }

    /**
     * Validates the instance.
     * 
     * @throws IllegalArgumentException thrown if the instance is not valid.
     */
    public void validate() {
        if (name() == null) {
            throw LOGGER.atError()
                .log(new IllegalArgumentException("Missing required property name in model Extension"));
        }
        if (isEnabled() == null) {
            throw LOGGER.atError()
                .log(new IllegalArgumentException("Missing required property isEnabled in model Extension"));
        }
        if (operationStatus() != null) {
            operationStatus().validate();
        }
    }

    private static final ClientLogger LOGGER = new ClientLogger(Extension.class);

    /**
     * {@inheritDoc}
     */
    @Override
    public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
        jsonWriter.writeStartObject();
        jsonWriter.writeStringField("name", this.name);
        jsonWriter.writeStringField("isEnabled", this.isEnabled == null ? null : this.isEnabled.toString());
        jsonWriter.writeMapField("additionalExtensionProperties", this.additionalExtensionProperties,
            (writer, element) -> writer.writeUntyped(element));
        return jsonWriter.writeEndObject();
    }

    /**
     * Reads an instance of Extension from the JsonReader.
     * 
     * @param jsonReader The JsonReader being read.
     * @return An instance of Extension if the JsonReader was pointing to an instance of it, or null if it was pointing
     * to JSON null.
     * @throws IllegalStateException If the deserialized JSON object was missing any required properties.
     * @throws IOException If an error occurs while reading the Extension.
     */
    public static Extension fromJson(JsonReader jsonReader) throws IOException {
        return jsonReader.readObject(reader -> {
            Extension deserializedExtension = new Extension();
            while (reader.nextToken() != JsonToken.END_OBJECT) {
                String fieldName = reader.getFieldName();
                reader.nextToken();

                if ("name".equals(fieldName)) {
                    deserializedExtension.name = reader.getString();
                } else if ("isEnabled".equals(fieldName)) {
                    deserializedExtension.isEnabled = IsEnabled.fromString(reader.getString());
                } else if ("additionalExtensionProperties".equals(fieldName)) {
                    Map additionalExtensionProperties
                        = reader.readMap(reader1 -> reader1.readUntyped());
                    deserializedExtension.additionalExtensionProperties = additionalExtensionProperties;
                } else if ("operationStatus".equals(fieldName)) {
                    deserializedExtension.operationStatus = OperationStatusAutoGenerated.fromJson(reader);
                } else {
                    reader.skipChildren();
                }
            }

            return deserializedExtension;
        });
    }
}