octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploy.getAccounts
Start a Neo task
Explain and create an octopusdeploy.getAccounts resource
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
Provides information about existing accounts.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";
const example = octopusdeploy.getAccounts({
accountType: "UsernamePassword",
ids: [
"Accounts-123",
"Accounts-321",
],
partialName: "Defau",
skip: 5,
take: 100,
});
import pulumi
import pulumi_octopusdeploy as octopusdeploy
example = octopusdeploy.get_accounts(account_type="UsernamePassword",
ids=[
"Accounts-123",
"Accounts-321",
],
partial_name="Defau",
skip=5,
take=100)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := octopusdeploy.GetAccounts(ctx, &octopusdeploy.GetAccountsArgs{
AccountType: pulumi.StringRef("UsernamePassword"),
Ids: []string{
"Accounts-123",
"Accounts-321",
},
PartialName: pulumi.StringRef("Defau"),
Skip: pulumi.Float64Ref(5),
Take: pulumi.Float64Ref(100),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;
return await Deployment.RunAsync(() =>
{
var example = Octopusdeploy.GetAccounts.Invoke(new()
{
AccountType = "UsernamePassword",
Ids = new[]
{
"Accounts-123",
"Accounts-321",
},
PartialName = "Defau",
Skip = 5,
Take = 100,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetAccountsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = OctopusdeployFunctions.getAccounts(GetAccountsArgs.builder()
.accountType("UsernamePassword")
.ids(
"Accounts-123",
"Accounts-321")
.partialName("Defau")
.skip(5)
.take(100)
.build());
}
}
variables:
example:
fn::invoke:
function: octopusdeploy:getAccounts
arguments:
accountType: UsernamePassword
ids:
- Accounts-123
- Accounts-321
partialName: Defau
skip: 5
take: 100
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(account_type: Optional[str] = None,
ids: Optional[Sequence[str]] = None,
partial_name: Optional[str] = None,
skip: Optional[float] = None,
space_id: Optional[str] = None,
take: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetAccountsResult
def get_accounts_output(account_type: Optional[pulumi.Input[str]] = None,
ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
partial_name: Optional[pulumi.Input[str]] = None,
skip: Optional[pulumi.Input[float]] = None,
space_id: Optional[pulumi.Input[str]] = None,
take: Optional[pulumi.Input[float]] = 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)
public static Output<GetAccountsResult> getAccounts(GetAccountsArgs args, InvokeOptions options)
fn::invoke:
function: octopusdeploy:index/getAccounts:getAccounts
arguments:
# arguments dictionaryThe following arguments are supported:
- Account
Type string - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - Ids List<string>
- A filter to search by a list of IDs.
- Partial
Name string - A filter to search by the partial match of a name.
- Skip double
- A filter to specify the number of items to skip in the response.
- Space
Id string - A Space ID to filter by. Will revert what is specified on the provider if not set.
- Take double
- A filter to specify the number of items to take (or return) in the response.
- Account
Type string - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - Ids []string
- A filter to search by a list of IDs.
- Partial
Name string - A filter to search by the partial match of a name.
- Skip float64
- A filter to specify the number of items to skip in the response.
- Space
Id string - A Space ID to filter by. Will revert what is specified on the provider if not set.
- Take float64
- A filter to specify the number of items to take (or return) in the response.
- account
Type String - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids List<String>
- A filter to search by a list of IDs.
- partial
Name String - A filter to search by the partial match of a name.
- skip Double
- A filter to specify the number of items to skip in the response.
- space
Id String - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take Double
- A filter to specify the number of items to take (or return) in the response.
- account
Type string - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids string[]
- A filter to search by a list of IDs.
- partial
Name string - A filter to search by the partial match of a name.
- skip number
- A filter to specify the number of items to skip in the response.
- space
Id string - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take number
- A filter to specify the number of items to take (or return) in the response.
- account_
type str - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids Sequence[str]
- A filter to search by a list of IDs.
- partial_
name str - A filter to search by the partial match of a name.
- skip float
- A filter to specify the number of items to skip in the response.
- space_
id str - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take float
- A filter to specify the number of items to take (or return) in the response.
- account
Type String - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids List<String>
- A filter to search by a list of IDs.
- partial
Name String - A filter to search by the partial match of a name.
- skip Number
- A filter to specify the number of items to skip in the response.
- space
Id String - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take Number
- A filter to specify the number of items to take (or return) in the response.
getAccounts Result
The following output properties are available:
- Accounts
List<Get
Accounts Account> - A list of accounts that match the filter(s).
- Id string
- An auto-generated identifier that includes the timestamp when this data source was last modified.
- Account
Type string - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - Ids List<string>
- A filter to search by a list of IDs.
- Partial
Name string - A filter to search by the partial match of a name.
- Skip double
- A filter to specify the number of items to skip in the response.
- Space
Id string - A Space ID to filter by. Will revert what is specified on the provider if not set.
- Take double
- A filter to specify the number of items to take (or return) in the response.
- Accounts
[]Get
Accounts Account - A list of accounts that match the filter(s).
- Id string
- An auto-generated identifier that includes the timestamp when this data source was last modified.
- Account
Type string - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - Ids []string
- A filter to search by a list of IDs.
- Partial
Name string - A filter to search by the partial match of a name.
- Skip float64
- A filter to specify the number of items to skip in the response.
- Space
Id string - A Space ID to filter by. Will revert what is specified on the provider if not set.
- Take float64
- A filter to specify the number of items to take (or return) in the response.
- accounts
List<Get
Accounts Account> - A list of accounts that match the filter(s).
- id String
- An auto-generated identifier that includes the timestamp when this data source was last modified.
- account
Type String - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids List<String>
- A filter to search by a list of IDs.
- partial
Name String - A filter to search by the partial match of a name.
- skip Double
- A filter to specify the number of items to skip in the response.
- space
Id String - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take Double
- A filter to specify the number of items to take (or return) in the response.
- accounts
Get
Accounts Account[] - A list of accounts that match the filter(s).
- id string
- An auto-generated identifier that includes the timestamp when this data source was last modified.
- account
Type string - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids string[]
- A filter to search by a list of IDs.
- partial
Name string - A filter to search by the partial match of a name.
- skip number
- A filter to specify the number of items to skip in the response.
- space
Id string - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take number
- A filter to specify the number of items to take (or return) in the response.
- accounts
Sequence[Get
Accounts Account] - A list of accounts that match the filter(s).
- id str
- An auto-generated identifier that includes the timestamp when this data source was last modified.
- account_
type str - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids Sequence[str]
- A filter to search by a list of IDs.
- partial_
name str - A filter to search by the partial match of a name.
- skip float
- A filter to specify the number of items to skip in the response.
- space_
id str - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take float
- A filter to specify the number of items to take (or return) in the response.
- accounts List<Property Map>
- A list of accounts that match the filter(s).
- id String
- An auto-generated identifier that includes the timestamp when this data source was last modified.
- account
Type String - A filter to search by a list of account types. Valid account types are
AmazonWebServicesAccount,AmazonWebServicesRoleAccount,AmazonWebServicesOidcAccount,AzureServicePrincipal,AzureSubscription,GenericOidcAccount,None,SshKeyPair,Token, orUsernamePassword. - ids List<String>
- A filter to search by a list of IDs.
- partial
Name String - A filter to search by the partial match of a name.
- skip Number
- A filter to specify the number of items to skip in the response.
- space
Id String - A Space ID to filter by. Will revert what is specified on the provider if not set.
- take Number
- A filter to specify the number of items to take (or return) in the response.
Supporting Types
GetAccountsAccount
- Access
Key string - Account
Type string - Active
Directory stringEndpoint Base Uri - Application
Id string - Authentication
Endpoint string - Azure
Environment string - Certificate
Data string - Certificate
Thumbprint string - Client
Secret string - Description string
- Environments List<string>
- Id string
- Name string
- Password string
- Private
Key stringFile - Private
Key stringPassphrase - Resource
Manager stringEndpoint - Secret
Key string - Service
Management stringEndpoint Base Uri - Service
Management stringEndpoint Suffix - Space
Id string - Subscription
Id string - Tenant
Id string - List<string>
- Tenanted
Deployment stringParticipation - Tenants List<string>
- Token string
- Username string
- Access
Key string - Account
Type string - Active
Directory stringEndpoint Base Uri - Application
Id string - Authentication
Endpoint string - Azure
Environment string - Certificate
Data string - Certificate
Thumbprint string - Client
Secret string - Description string
- Environments []string
- Id string
- Name string
- Password string
- Private
Key stringFile - Private
Key stringPassphrase - Resource
Manager stringEndpoint - Secret
Key string - Service
Management stringEndpoint Base Uri - Service
Management stringEndpoint Suffix - Space
Id string - Subscription
Id string - Tenant
Id string - []string
- Tenanted
Deployment stringParticipation - Tenants []string
- Token string
- Username string
- access
Key String - account
Type String - active
Directory StringEndpoint Base Uri - application
Id String - authentication
Endpoint String - azure
Environment String - certificate
Data String - certificate
Thumbprint String - client
Secret String - description String
- environments List<String>
- id String
- name String
- password String
- private
Key StringFile - private
Key StringPassphrase - resource
Manager StringEndpoint - secret
Key String - service
Management StringEndpoint Base Uri - service
Management StringEndpoint Suffix - space
Id String - subscription
Id String - tenant
Id String - List<String>
- tenanted
Deployment StringParticipation - tenants List<String>
- token String
- username String
- access
Key string - account
Type string - active
Directory stringEndpoint Base Uri - application
Id string - authentication
Endpoint string - azure
Environment string - certificate
Data string - certificate
Thumbprint string - client
Secret string - description string
- environments string[]
- id string
- name string
- password string
- private
Key stringFile - private
Key stringPassphrase - resource
Manager stringEndpoint - secret
Key string - service
Management stringEndpoint Base Uri - service
Management stringEndpoint Suffix - space
Id string - subscription
Id string - tenant
Id string - string[]
- tenanted
Deployment stringParticipation - tenants string[]
- token string
- username string
- access_
key str - account_
type str - active_
directory_ strendpoint_ base_ uri - application_
id str - authentication_
endpoint str - azure_
environment str - certificate_
data str - certificate_
thumbprint str - client_
secret str - description str
- environments Sequence[str]
- id str
- name str
- password str
- private_
key_ strfile - private_
key_ strpassphrase - resource_
manager_ strendpoint - secret_
key str - service_
management_ strendpoint_ base_ uri - service_
management_ strendpoint_ suffix - space_
id str - subscription_
id str - tenant_
id str - Sequence[str]
- tenanted_
deployment_ strparticipation - tenants Sequence[str]
- token str
- username str
- access
Key String - account
Type String - active
Directory StringEndpoint Base Uri - application
Id String - authentication
Endpoint String - azure
Environment String - certificate
Data String - certificate
Thumbprint String - client
Secret String - description String
- environments List<String>
- id String
- name String
- password String
- private
Key StringFile - private
Key StringPassphrase - resource
Manager StringEndpoint - secret
Key String - service
Management StringEndpoint Base Uri - service
Management StringEndpoint Suffix - space
Id String - subscription
Id String - tenant
Id String - List<String>
- tenanted
Deployment StringParticipation - tenants List<String>
- token String
- username String
Package Details
- Repository
- octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
- License
- Notes
- This Pulumi package is based on the
octopusdeployTerraform Provider.
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
