Package com.azure.resourcemanager.synapse.models

Interface Key

public interface Key
An immutable client-side representation of Key.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Key.Definition
    The entirety of the Key definition.
    static interface 
    Key.DefinitionStages
    The Key definition stages.
    static interface 
    Key.Update
    The template for Key update.
    static interface 
    Key.UpdateStages
    The Key update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    KeyInner
    innerModel()
    Gets the inner com.azure.resourcemanager.synapse.fluent.models.KeyInner object.
    Boolean
    isActiveCmk()
    Gets the isActiveCmk property: Used to activate the workspace after a customer managed key is provided.
    String
    keyVaultUrl()
    Gets the keyVaultUrl property: The Key Vault Url of the workspace key.
    String
    name()
    Gets the name property: The name of the resource.
    Key
    refresh()
    Refreshes the resource to sync with Azure.
    Key
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    String
    resourceGroupName()
    Gets the name of the resource group.
    String
    type()
    Gets the type property: The type of the resource.
    Key.Update
    update()
    Begins update for the Key resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • isActiveCmk

      Boolean isActiveCmk()
      Gets the isActiveCmk property: Used to activate the workspace after a customer managed key is provided.
      Returns:
      the isActiveCmk value.

    • keyVaultUrl

      String keyVaultUrl()
      Gets the keyVaultUrl property: The Key Vault Url of the workspace key.
      Returns:
      the keyVaultUrl value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      KeyInner innerModel()
      Gets the inner com.azure.resourcemanager.synapse.fluent.models.KeyInner object.
      Returns:
      the inner object.

    • update

      Key.Update update()
      Begins update for the Key resource.
      Returns:
      the stage of resource update.

    • refresh

      Key refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Key refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.