1. Packages
  2. Snowflake
  3. API Docs
  4. getAccounts
Snowflake v0.60.0 published on Monday, Oct 14, 2024 by Pulumi

snowflake.getAccounts

Explore with Pulumi AI

snowflake logo
Snowflake v0.60.0 published on Monday, Oct 14, 2024 by Pulumi

    Using getAccounts

    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 getAccounts(args: GetAccountsArgs, opts?: InvokeOptions): Promise<GetAccountsResult>
    function getAccountsOutput(args: GetAccountsOutputArgs, opts?: InvokeOptions): Output<GetAccountsResult>
    def get_accounts(pattern: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAccountsResult
    def get_accounts_output(pattern: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAccountsResult]
    func GetAccounts(ctx *Context, args *GetAccountsArgs, opts ...InvokeOption) (*GetAccountsResult, error)
    func GetAccountsOutput(ctx *Context, args *GetAccountsOutputArgs, opts ...InvokeOption) GetAccountsResultOutput

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

    public static class GetAccounts 
    {
        public static Task<GetAccountsResult> InvokeAsync(GetAccountsArgs args, InvokeOptions? opts = null)
        public static Output<GetAccountsResult> Invoke(GetAccountsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccountsResult> getAccounts(GetAccountsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: snowflake:index/getAccounts:getAccounts
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Pattern string
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    Pattern string
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    pattern String
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    pattern string
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    pattern str
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    pattern String
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.

    getAccounts Result

    The following output properties are available:

    Accounts List<GetAccountsAccount>
    List of all the accounts available in the organization.
    Id string
    The provider-assigned unique ID for this managed resource.
    Pattern string
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    Accounts []GetAccountsAccount
    List of all the accounts available in the organization.
    Id string
    The provider-assigned unique ID for this managed resource.
    Pattern string
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    accounts List<GetAccountsAccount>
    List of all the accounts available in the organization.
    id String
    The provider-assigned unique ID for this managed resource.
    pattern String
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    accounts GetAccountsAccount[]
    List of all the accounts available in the organization.
    id string
    The provider-assigned unique ID for this managed resource.
    pattern string
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    accounts Sequence[GetAccountsAccount]
    List of all the accounts available in the organization.
    id str
    The provider-assigned unique ID for this managed resource.
    pattern str
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.
    accounts List<Property Map>
    List of all the accounts available in the organization.
    id String
    The provider-assigned unique ID for this managed resource.
    pattern String
    Specifies an account name pattern. If a pattern is specified, only accounts matching the pattern are returned.

    Supporting Types

    GetAccountsAccount

    AccountLocator string
    System-assigned identifier of the acccount.
    AccountLocatorUrl string
    Legacy Snowflake access URL syntax that includes the region_name and account_locator.
    AccountName string
    User-defined name that identifies an account within the organization.
    AccountUrl string
    Preferred Snowflake access URL that includes the values of organization_name and account_name.
    Comment string
    Comment for the account.
    ConsumptionBillingEntityName string
    Name of the consumption billing entity.
    CreatedOn string
    Date and time when the account was created.
    Edition string
    Snowflake Edition of the account.
    IsOrgAdmin bool
    Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
    ManagedAccounts int
    Indicates how many managed accounts have been created by the account.
    MarketplaceConsumerBillingEntityName string
    Name of the marketplace consumer billing entity.
    MarketplaceProviderBillingEntityName string
    Name of the marketplace provider billing entity.
    OldAccountUrl string
    The previous account URL for a given account.
    OrganizationName string
    Name of the organization.
    RegionGroup string
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    SnowflakeRegion string
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    AccountLocator string
    System-assigned identifier of the acccount.
    AccountLocatorUrl string
    Legacy Snowflake access URL syntax that includes the region_name and account_locator.
    AccountName string
    User-defined name that identifies an account within the organization.
    AccountUrl string
    Preferred Snowflake access URL that includes the values of organization_name and account_name.
    Comment string
    Comment for the account.
    ConsumptionBillingEntityName string
    Name of the consumption billing entity.
    CreatedOn string
    Date and time when the account was created.
    Edition string
    Snowflake Edition of the account.
    IsOrgAdmin bool
    Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
    ManagedAccounts int
    Indicates how many managed accounts have been created by the account.
    MarketplaceConsumerBillingEntityName string
    Name of the marketplace consumer billing entity.
    MarketplaceProviderBillingEntityName string
    Name of the marketplace provider billing entity.
    OldAccountUrl string
    The previous account URL for a given account.
    OrganizationName string
    Name of the organization.
    RegionGroup string
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    SnowflakeRegion string
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    accountLocator String
    System-assigned identifier of the acccount.
    accountLocatorUrl String
    Legacy Snowflake access URL syntax that includes the region_name and account_locator.
    accountName String
    User-defined name that identifies an account within the organization.
    accountUrl String
    Preferred Snowflake access URL that includes the values of organization_name and account_name.
    comment String
    Comment for the account.
    consumptionBillingEntityName String
    Name of the consumption billing entity.
    createdOn String
    Date and time when the account was created.
    edition String
    Snowflake Edition of the account.
    isOrgAdmin Boolean
    Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
    managedAccounts Integer
    Indicates how many managed accounts have been created by the account.
    marketplaceConsumerBillingEntityName String
    Name of the marketplace consumer billing entity.
    marketplaceProviderBillingEntityName String
    Name of the marketplace provider billing entity.
    oldAccountUrl String
    The previous account URL for a given account.
    organizationName String
    Name of the organization.
    regionGroup String
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    snowflakeRegion String
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    accountLocator string
    System-assigned identifier of the acccount.
    accountLocatorUrl string
    Legacy Snowflake access URL syntax that includes the region_name and account_locator.
    accountName string
    User-defined name that identifies an account within the organization.
    accountUrl string
    Preferred Snowflake access URL that includes the values of organization_name and account_name.
    comment string
    Comment for the account.
    consumptionBillingEntityName string
    Name of the consumption billing entity.
    createdOn string
    Date and time when the account was created.
    edition string
    Snowflake Edition of the account.
    isOrgAdmin boolean
    Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
    managedAccounts number
    Indicates how many managed accounts have been created by the account.
    marketplaceConsumerBillingEntityName string
    Name of the marketplace consumer billing entity.
    marketplaceProviderBillingEntityName string
    Name of the marketplace provider billing entity.
    oldAccountUrl string
    The previous account URL for a given account.
    organizationName string
    Name of the organization.
    regionGroup string
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    snowflakeRegion string
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    account_locator str
    System-assigned identifier of the acccount.
    account_locator_url str
    Legacy Snowflake access URL syntax that includes the region_name and account_locator.
    account_name str
    User-defined name that identifies an account within the organization.
    account_url str
    Preferred Snowflake access URL that includes the values of organization_name and account_name.
    comment str
    Comment for the account.
    consumption_billing_entity_name str
    Name of the consumption billing entity.
    created_on str
    Date and time when the account was created.
    edition str
    Snowflake Edition of the account.
    is_org_admin bool
    Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
    managed_accounts int
    Indicates how many managed accounts have been created by the account.
    marketplace_consumer_billing_entity_name str
    Name of the marketplace consumer billing entity.
    marketplace_provider_billing_entity_name str
    Name of the marketplace provider billing entity.
    old_account_url str
    The previous account URL for a given account.
    organization_name str
    Name of the organization.
    region_group str
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    snowflake_region str
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    accountLocator String
    System-assigned identifier of the acccount.
    accountLocatorUrl String
    Legacy Snowflake access URL syntax that includes the region_name and account_locator.
    accountName String
    User-defined name that identifies an account within the organization.
    accountUrl String
    Preferred Snowflake access URL that includes the values of organization_name and account_name.
    comment String
    Comment for the account.
    consumptionBillingEntityName String
    Name of the consumption billing entity.
    createdOn String
    Date and time when the account was created.
    edition String
    Snowflake Edition of the account.
    isOrgAdmin Boolean
    Indicates whether the ORGADMIN role is enabled in an account. If TRUE, the role is enabled.
    managedAccounts Number
    Indicates how many managed accounts have been created by the account.
    marketplaceConsumerBillingEntityName String
    Name of the marketplace consumer billing entity.
    marketplaceProviderBillingEntityName String
    Name of the marketplace provider billing entity.
    oldAccountUrl String
    The previous account URL for a given account.
    organizationName String
    Name of the organization.
    regionGroup String
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    snowflakeRegion String
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.60.0 published on Monday, Oct 14, 2024 by Pulumi