com.microsoft.azure.management.sql.SqlEncryptionProtector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-mgmt-sql Show documentation
This package contains Microsoft Azure SDK for SQL Management module.
There is a newer version: 1.41.4
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
package com.microsoft.azure.management.sql;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.resources.fluentcore.arm.Region;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasId;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Indexable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.sql.implementation.EncryptionProtectorInner;

/**
 * An immutable client-side representation of an Azure SQL Encryption Protector.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_9_0)
public interface SqlEncryptionProtector
    extends
        HasId,
        HasInner,
        HasResourceGroup,
        Indexable,
        Refreshable,
        Updatable {

    /**
     * @return name of the SQL Server to which this DNS alias belongs
     */
    String sqlServerName();

    /**
     * @return the parent SQL server ID
     */
    String parentId();

    /**
     * @return  the kind of encryption protector; this is metadata used for the Azure Portal experience
     */
    String kind();

    /**
     * @return the resource location
     */
    Region region();

    /**
     * @return the name of the server key
     */
    String serverKeyName();

    /**
     * @return the encryption protector type
     */
    ServerKeyType serverKeyType();

    /**
     * @return the URI of the server key
     */
    String uri();

    /**
     * @return thumbprint of the server key
     */
    String thumbprint();

    /**
     * The template for a SQL Encryption Protector update operation, containing all the settings that can be modified.
     */
    interface Update extends
        SqlEncryptionProtector.UpdateStages.WithServerKeyNameAndType,
        Appliable {
    }

    /**
     * Grouping of all the SQL Encryption Protector update stages.
     */
    interface UpdateStages {
        /**
         * The SQL Encryption Protector update definition to set the server key name and type.
         */
        @Beta(Beta.SinceVersion.V1_9_0)
        interface WithServerKeyNameAndType {
            /**
             * Updates the Encryption Protector to use an AzureKeyVault server key.
             *
             * @param serverKeyName the server key name
             * @return The next stage of the definition.
             */
            SqlEncryptionProtector.Update withAzureKeyVaultServerKey(String serverKeyName);

            /**
             * Updates the Encryption Protector to use the default service managed server key.
             *
             * @return The next stage of the definition.
             */
            @Method
            SqlEncryptionProtector.Update withServiceManagedServerKey();
        }
    }
}