1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getEncryptionProtector
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.sql.getEncryptionProtector

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Gets a server encryption protector.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2015-05-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Using getEncryptionProtector

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEncryptionProtector(args: GetEncryptionProtectorArgs, opts?: InvokeOptions): Promise<GetEncryptionProtectorResult>
    function getEncryptionProtectorOutput(args: GetEncryptionProtectorOutputArgs, opts?: InvokeOptions): Output<GetEncryptionProtectorResult>
    def get_encryption_protector(encryption_protector_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 server_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetEncryptionProtectorResult
    def get_encryption_protector_output(encryption_protector_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 server_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetEncryptionProtectorResult]
    func LookupEncryptionProtector(ctx *Context, args *LookupEncryptionProtectorArgs, opts ...InvokeOption) (*LookupEncryptionProtectorResult, error)
    func LookupEncryptionProtectorOutput(ctx *Context, args *LookupEncryptionProtectorOutputArgs, opts ...InvokeOption) LookupEncryptionProtectorResultOutput

    > Note: This function is named LookupEncryptionProtector in the Go SDK.

    public static class GetEncryptionProtector 
    {
        public static Task<GetEncryptionProtectorResult> InvokeAsync(GetEncryptionProtectorArgs args, InvokeOptions? opts = null)
        public static Output<GetEncryptionProtectorResult> Invoke(GetEncryptionProtectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEncryptionProtectorResult> getEncryptionProtector(GetEncryptionProtectorArgs args, InvokeOptions options)
    public static Output<GetEncryptionProtectorResult> getEncryptionProtector(GetEncryptionProtectorArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:sql:getEncryptionProtector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EncryptionProtectorName string
    The name of the encryption protector to be retrieved.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    EncryptionProtectorName string
    The name of the encryption protector to be retrieved.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    encryptionProtectorName String
    The name of the encryption protector to be retrieved.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    encryptionProtectorName string
    The name of the encryption protector to be retrieved.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName string
    The name of the server.
    encryption_protector_name str
    The name of the encryption protector to be retrieved.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    server_name str
    The name of the server.
    encryptionProtectorName String
    The name of the encryption protector to be retrieved.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.

    getEncryptionProtector Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Kind string
    Kind of encryption protector. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    Name string
    Resource name.
    ServerKeyType string
    The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
    Subregion string
    Subregion of the encryption protector.
    Thumbprint string
    Thumbprint of the server key.
    Type string
    Resource type.
    Uri string
    The URI of the server key.
    AutoRotationEnabled bool
    Key auto rotation opt-in flag. Either true or false.
    ServerKeyName string
    The name of the server key.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Kind string
    Kind of encryption protector. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    Name string
    Resource name.
    ServerKeyType string
    The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
    Subregion string
    Subregion of the encryption protector.
    Thumbprint string
    Thumbprint of the server key.
    Type string
    Resource type.
    Uri string
    The URI of the server key.
    AutoRotationEnabled bool
    Key auto rotation opt-in flag. Either true or false.
    ServerKeyName string
    The name of the server key.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    kind String
    Kind of encryption protector. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    name String
    Resource name.
    serverKeyType String
    The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
    subregion String
    Subregion of the encryption protector.
    thumbprint String
    Thumbprint of the server key.
    type String
    Resource type.
    uri String
    The URI of the server key.
    autoRotationEnabled Boolean
    Key auto rotation opt-in flag. Either true or false.
    serverKeyName String
    The name of the server key.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID.
    kind string
    Kind of encryption protector. This is metadata used for the Azure portal experience.
    location string
    Resource location.
    name string
    Resource name.
    serverKeyType string
    The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
    subregion string
    Subregion of the encryption protector.
    thumbprint string
    Thumbprint of the server key.
    type string
    Resource type.
    uri string
    The URI of the server key.
    autoRotationEnabled boolean
    Key auto rotation opt-in flag. Either true or false.
    serverKeyName string
    The name of the server key.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID.
    kind str
    Kind of encryption protector. This is metadata used for the Azure portal experience.
    location str
    Resource location.
    name str
    Resource name.
    server_key_type str
    The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
    subregion str
    Subregion of the encryption protector.
    thumbprint str
    Thumbprint of the server key.
    type str
    Resource type.
    uri str
    The URI of the server key.
    auto_rotation_enabled bool
    Key auto rotation opt-in flag. Either true or false.
    server_key_name str
    The name of the server key.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    kind String
    Kind of encryption protector. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    name String
    Resource name.
    serverKeyType String
    The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
    subregion String
    Subregion of the encryption protector.
    thumbprint String
    Thumbprint of the server key.
    type String
    Resource type.
    uri String
    The URI of the server key.
    autoRotationEnabled Boolean
    Key auto rotation opt-in flag. Either true or false.
    serverKeyName String
    The name of the server key.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi