Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. iam
  6. getApiKey
Viewing docs for bytepluscc v0.0.53
published on Thursday, Sep 10, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.iam.getApiKey

bytepluscc logo
Viewing docs for bytepluscc v0.0.53
published on Thursday, Sep 10, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::IAM::ApiKey

    Using getApiKey

    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 getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetApiKeyResult>
    def get_api_key(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
def get_api_key_output(id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetApiKeyResult]
    func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput

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

    public static class GetApiKey 
{
    public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
public static Output<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
public static Output<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: bytepluscc:iam/getApiKey:getApiKey
  arguments:
    # arguments dictionary
    data "bytepluscc_iam_get_api_key" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getApiKey Result

    The following output properties are available:

    ApiKeyId string
    API Key ID。
    CreateDate string
    Created At
    Id string
    Uniquely identifies the resource.
    Name string
    API Key Name
    PermissionsBoundary string
    Permission Boundary
    Secret string
    API Key Secret
    Status string
    API Key Status
    UpdateDate string
    Last Updated
    UserName string
    Username
    ApiKeyId string
    API Key ID。
    CreateDate string
    Created At
    Id string
    Uniquely identifies the resource.
    Name string
    API Key Name
    PermissionsBoundary string
    Permission Boundary
    Secret string
    API Key Secret
    Status string
    API Key Status
    UpdateDate string
    Last Updated
    UserName string
    Username
    api_key_id string
    API Key ID。
    create_date string
    Created At
    id string
    Uniquely identifies the resource.
    name string
    API Key Name
    permissions_boundary string
    Permission Boundary
    secret string
    API Key Secret
    status string
    API Key Status
    update_date string
    Last Updated
    user_name string
    Username
    apiKeyId String
    API Key ID。
    createDate String
    Created At
    id String
    Uniquely identifies the resource.
    name String
    API Key Name
    permissionsBoundary String
    Permission Boundary
    secret String
    API Key Secret
    status String
    API Key Status
    updateDate String
    Last Updated
    userName String
    Username
    apiKeyId string
    API Key ID。
    createDate string
    Created At
    id string
    Uniquely identifies the resource.
    name string
    API Key Name
    permissionsBoundary string
    Permission Boundary
    secret string
    API Key Secret
    status string
    API Key Status
    updateDate string
    Last Updated
    userName string
    Username
    api_key_id str
    API Key ID。
    create_date str
    Created At
    id str
    Uniquely identifies the resource.
    name str
    API Key Name
    permissions_boundary str
    Permission Boundary
    secret str
    API Key Secret
    status str
    API Key Status
    update_date str
    Last Updated
    user_name str
    Username
    apiKeyId String
    API Key ID。
    createDate String
    Created At
    id String
    Uniquely identifies the resource.
    name String
    API Key Name
    permissionsBoundary String
    Permission Boundary
    secret String
    API Key Secret
    status String
    API Key Status
    updateDate String
    Last Updated
    userName String
    Username

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.53
    published on Thursday, Sep 10, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial