1. Packages
  2. Databricks
  3. API Docs
  4. getStorageCredential
Databricks v1.38.0 published on Monday, Apr 29, 2024 by Pulumi

databricks.getStorageCredential

Explore with Pulumi AI

databricks logo
Databricks v1.38.0 published on Monday, Apr 29, 2024 by Pulumi

    Example Usage

    Getting details of an existing storage credential in the metastore

    Using getStorageCredential

    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 getStorageCredential(args: GetStorageCredentialArgs, opts?: InvokeOptions): Promise<GetStorageCredentialResult>
    function getStorageCredentialOutput(args: GetStorageCredentialOutputArgs, opts?: InvokeOptions): Output<GetStorageCredentialResult>
    def get_storage_credential(name: Optional[str] = None,
                               storage_credential_info: Optional[GetStorageCredentialStorageCredentialInfo] = None,
                               opts: Optional[InvokeOptions] = None) -> GetStorageCredentialResult
    def get_storage_credential_output(name: Optional[pulumi.Input[str]] = None,
                               storage_credential_info: Optional[pulumi.Input[GetStorageCredentialStorageCredentialInfoArgs]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetStorageCredentialResult]
    func LookupStorageCredential(ctx *Context, args *LookupStorageCredentialArgs, opts ...InvokeOption) (*LookupStorageCredentialResult, error)
    func LookupStorageCredentialOutput(ctx *Context, args *LookupStorageCredentialOutputArgs, opts ...InvokeOption) LookupStorageCredentialResultOutput

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

    public static class GetStorageCredential 
    {
        public static Task<GetStorageCredentialResult> InvokeAsync(GetStorageCredentialArgs args, InvokeOptions? opts = null)
        public static Output<GetStorageCredentialResult> Invoke(GetStorageCredentialInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStorageCredentialResult> getStorageCredential(GetStorageCredentialArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: databricks:index/getStorageCredential:getStorageCredential
      arguments:
        # arguments dictionary

    The following arguments are supported:

    name String
    The name of the storage credential
    storageCredentialInfo Property Map

    getStorageCredential Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    StorageCredentialInfo GetStorageCredentialStorageCredentialInfo
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    StorageCredentialInfo GetStorageCredentialStorageCredentialInfo
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    storageCredentialInfo GetStorageCredentialStorageCredentialInfo
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    storageCredentialInfo GetStorageCredentialStorageCredentialInfo
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    storage_credential_info GetStorageCredentialStorageCredentialInfo
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    storageCredentialInfo Property Map

    Supporting Types

    GetStorageCredentialStorageCredentialInfo

    awsIamRole Property Map
    azureManagedIdentity Property Map
    azureServicePrincipal Property Map
    cloudflareApiToken Property Map
    comment String
    createdAt Number
    createdBy String
    databricksGcpServiceAccount Property Map
    id String
    metastoreId String
    Unique identifier of the parent Metastore.
    name String
    The name of the storage credential
    owner String
    Username/groupname/sp application_id of the storage credential owner.
    readOnly Boolean
    Indicates whether the storage credential is only usable for read operations.
    updatedAt Number
    updatedBy String
    usedForManagedStorage Boolean

    GetStorageCredentialStorageCredentialInfoAwsIamRole

    RoleArn string
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    ExternalId string
    (output only) - The external ID used in role assumption to prevent confused deputy problem.
    UnityCatalogIamArn string
    (output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.
    RoleArn string
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    ExternalId string
    (output only) - The external ID used in role assumption to prevent confused deputy problem.
    UnityCatalogIamArn string
    (output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.
    roleArn String
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    externalId String
    (output only) - The external ID used in role assumption to prevent confused deputy problem.
    unityCatalogIamArn String
    (output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.
    roleArn string
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    externalId string
    (output only) - The external ID used in role assumption to prevent confused deputy problem.
    unityCatalogIamArn string
    (output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.
    role_arn str
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    external_id str
    (output only) - The external ID used in role assumption to prevent confused deputy problem.
    unity_catalog_iam_arn str
    (output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.
    roleArn String
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    externalId String
    (output only) - The external ID used in role assumption to prevent confused deputy problem.
    unityCatalogIamArn String
    (output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.

    GetStorageCredentialStorageCredentialInfoAzureManagedIdentity

    AccessConnectorId string
    The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name.
    CredentialId string
    ManagedIdentityId string
    The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name.
    AccessConnectorId string
    The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name.
    CredentialId string
    ManagedIdentityId string
    The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name.
    accessConnectorId String
    The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name.
    credentialId String
    managedIdentityId String
    The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name.
    accessConnectorId string
    The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name.
    credentialId string
    managedIdentityId string
    The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name.
    access_connector_id str
    The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name.
    credential_id str
    managed_identity_id str
    The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name.
    accessConnectorId String
    The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name.
    credentialId String
    managedIdentityId String
    The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name.

    GetStorageCredentialStorageCredentialInfoAzureServicePrincipal

    ApplicationId string
    The application ID of the application registration within the referenced AAD tenant
    ClientSecret string
    DirectoryId string
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    ApplicationId string
    The application ID of the application registration within the referenced AAD tenant
    ClientSecret string
    DirectoryId string
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    applicationId String
    The application ID of the application registration within the referenced AAD tenant
    clientSecret String
    directoryId String
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    applicationId string
    The application ID of the application registration within the referenced AAD tenant
    clientSecret string
    directoryId string
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    application_id str
    The application ID of the application registration within the referenced AAD tenant
    client_secret str
    directory_id str
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    applicationId String
    The application ID of the application registration within the referenced AAD tenant
    clientSecret String
    directoryId String
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application

    GetStorageCredentialStorageCredentialInfoCloudflareApiToken

    GetStorageCredentialStorageCredentialInfoDatabricksGcpServiceAccount

    CredentialId string
    Email string
    The email of the GCP service account created, to be granted access to relevant buckets.
    CredentialId string
    Email string
    The email of the GCP service account created, to be granted access to relevant buckets.
    credentialId String
    email String
    The email of the GCP service account created, to be granted access to relevant buckets.
    credentialId string
    email string
    The email of the GCP service account created, to be granted access to relevant buckets.
    credential_id str
    email str
    The email of the GCP service account created, to be granted access to relevant buckets.
    credentialId String
    email String
    The email of the GCP service account created, to be granted access to relevant buckets.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.38.0 published on Monday, Apr 29, 2024 by Pulumi