octopusdeploy.getCertificates

octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs

octopusdeploylabs/terraform-provider-octopusdeploy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = octopusdeploy.getCertificates({
    archived: "false",
    ids: [
        "Certificates-123",
        "Certificates-321",
    ],
    partialName: "Defau",
    skip: 5,
    take: 100,
});

import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_certificates(archived="false",
    ids=[
        "Certificates-123",
        "Certificates-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.GetCertificates(ctx, &octopusdeploy.GetCertificatesArgs{
			Archived: pulumi.StringRef("false"),
			Ids: []string{
				"Certificates-123",
				"Certificates-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.GetCertificates.Invoke(new()
    {
        Archived = "false",
        Ids = new[]
        {
            "Certificates-123",
            "Certificates-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.GetCertificatesArgs;
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.getCertificates(GetCertificatesArgs.builder()
            .archived(false)
            .ids(            
                "Certificates-123",
                "Certificates-321")
            .partialName("Defau")
            .skip(5)
            .take(100)
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: octopusdeploy:getCertificates
      arguments:
        archived: false
        ids:
          - Certificates-123
          - Certificates-321
        partialName: Defau
        skip: 5
        take: 100

Using getCertificates

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 getCertificates(args: GetCertificatesArgs, opts?: InvokeOptions): Promise<GetCertificatesResult>
function getCertificatesOutput(args: GetCertificatesOutputArgs, opts?: InvokeOptions): Output<GetCertificatesResult>

def get_certificates(archived: Optional[str] = None,
                     first_result: Optional[str] = None,
                     ids: Optional[Sequence[str]] = None,
                     order_by: Optional[str] = None,
                     partial_name: Optional[str] = None,
                     search: Optional[str] = None,
                     skip: Optional[float] = None,
                     space_id: Optional[str] = None,
                     take: Optional[float] = None,
                     tenant: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCertificatesResult
def get_certificates_output(archived: Optional[pulumi.Input[str]] = None,
                     first_result: Optional[pulumi.Input[str]] = None,
                     ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     order_by: Optional[pulumi.Input[str]] = None,
                     partial_name: Optional[pulumi.Input[str]] = None,
                     search: Optional[pulumi.Input[str]] = None,
                     skip: Optional[pulumi.Input[float]] = None,
                     space_id: Optional[pulumi.Input[str]] = None,
                     take: Optional[pulumi.Input[float]] = None,
                     tenant: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCertificatesResult]

func GetCertificates(ctx *Context, args *GetCertificatesArgs, opts ...InvokeOption) (*GetCertificatesResult, error)
func GetCertificatesOutput(ctx *Context, args *GetCertificatesOutputArgs, opts ...InvokeOption) GetCertificatesResultOutput

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

public static class GetCertificates 
{
    public static Task<GetCertificatesResult> InvokeAsync(GetCertificatesArgs args, InvokeOptions? opts = null)
    public static Output<GetCertificatesResult> Invoke(GetCertificatesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCertificatesResult> getCertificates(GetCertificatesArgs args, InvokeOptions options)
public static Output<GetCertificatesResult> getCertificates(GetCertificatesArgs args, InvokeOptions options)

fn::invoke:
  function: octopusdeploy:index/getCertificates:getCertificates
  arguments:
    # arguments dictionary

The following arguments are supported:

Archived string: A filter to search for resources that have been archived.
FirstResult string: A filter to define the first result.
Ids List<string>: A filter to search by a list of IDs.
OrderBy string: A filter used to order the search results.
PartialName string: A filter to search by the partial match of a name.
Search string: A filter of terms used the search operation.
Skip double: A filter to specify the number of items to skip in the response.
SpaceId string: The space ID associated with this resource.
Take double: A filter to specify the number of items to take (or return) in the response.
Tenant string: A filter to search by a tenant ID.

Archived string: A filter to search for resources that have been archived.
FirstResult string: A filter to define the first result.
Ids []string: A filter to search by a list of IDs.
OrderBy string: A filter used to order the search results.
PartialName string: A filter to search by the partial match of a name.
Search string: A filter of terms used the search operation.
Skip float64: A filter to specify the number of items to skip in the response.
SpaceId string: The space ID associated with this resource.
Take float64: A filter to specify the number of items to take (or return) in the response.
Tenant string: A filter to search by a tenant ID.

archived String: A filter to search for resources that have been archived.
firstResult String: A filter to define the first result.
ids List<String>: A filter to search by a list of IDs.
orderBy String: A filter used to order the search results.
partialName String: A filter to search by the partial match of a name.
search String: A filter of terms used the search operation.
skip Double: A filter to specify the number of items to skip in the response.
spaceId String: The space ID associated with this resource.
take Double: A filter to specify the number of items to take (or return) in the response.
tenant String: A filter to search by a tenant ID.

archived string: A filter to search for resources that have been archived.
firstResult string: A filter to define the first result.
ids string[]: A filter to search by a list of IDs.
orderBy string: A filter used to order the search results.
partialName string: A filter to search by the partial match of a name.
search string: A filter of terms used the search operation.
skip number: A filter to specify the number of items to skip in the response.
spaceId string: The space ID associated with this resource.
take number: A filter to specify the number of items to take (or return) in the response.
tenant string: A filter to search by a tenant ID.

archived str: A filter to search for resources that have been archived.
first_result str: A filter to define the first result.
ids Sequence[str]: A filter to search by a list of IDs.
order_by str: A filter used to order the search results.
partial_name str: A filter to search by the partial match of a name.
search str: A filter of terms used the search operation.
skip float: A filter to specify the number of items to skip in the response.
space_id str: The space ID associated with this resource.
take float: A filter to specify the number of items to take (or return) in the response.
tenant str: A filter to search by a tenant ID.

archived String: A filter to search for resources that have been archived.
firstResult String: A filter to define the first result.
ids List<String>: A filter to search by a list of IDs.
orderBy String: A filter used to order the search results.
partialName String: A filter to search by the partial match of a name.
search String: A filter of terms used the search operation.
skip Number: A filter to specify the number of items to skip in the response.
spaceId String: The space ID associated with this resource.
take Number: A filter to specify the number of items to take (or return) in the response.
tenant String: A filter to search by a tenant ID.

getCertificates Result

The following output properties are available:

Certificates List<GetCertificatesCertificate>: A list of certificates that match the filter(s).
Id string: An auto-generated identifier that includes the timestamp when this data source was last modified.
SpaceId string: The space ID associated with this resource.
Archived string: A filter to search for resources that have been archived.
FirstResult string: A filter to define the first result.
Ids List<string>: A filter to search by a list of IDs.
OrderBy string: A filter used to order the search results.
PartialName string: A filter to search by the partial match of a name.
Search string: A filter of terms used the search operation.
Skip double: A filter to specify the number of items to skip in the response.
Take double: A filter to specify the number of items to take (or return) in the response.
Tenant string: A filter to search by a tenant ID.

Certificates []GetCertificatesCertificate: A list of certificates that match the filter(s).
Id string: An auto-generated identifier that includes the timestamp when this data source was last modified.
SpaceId string: The space ID associated with this resource.
Archived string: A filter to search for resources that have been archived.
FirstResult string: A filter to define the first result.
Ids []string: A filter to search by a list of IDs.
OrderBy string: A filter used to order the search results.
PartialName string: A filter to search by the partial match of a name.
Search string: A filter of terms used the search operation.
Skip float64: A filter to specify the number of items to skip in the response.
Take float64: A filter to specify the number of items to take (or return) in the response.
Tenant string: A filter to search by a tenant ID.

certificates List<GetCertificatesCertificate>: A list of certificates that match the filter(s).
id String: An auto-generated identifier that includes the timestamp when this data source was last modified.
spaceId String: The space ID associated with this resource.
archived String: A filter to search for resources that have been archived.
firstResult String: A filter to define the first result.
ids List<String>: A filter to search by a list of IDs.
orderBy String: A filter used to order the search results.
partialName String: A filter to search by the partial match of a name.
search String: A filter of terms used the search operation.
skip Double: A filter to specify the number of items to skip in the response.
take Double: A filter to specify the number of items to take (or return) in the response.
tenant String: A filter to search by a tenant ID.

certificates GetCertificatesCertificate[]: A list of certificates that match the filter(s).
id string: An auto-generated identifier that includes the timestamp when this data source was last modified.
spaceId string: The space ID associated with this resource.
archived string: A filter to search for resources that have been archived.
firstResult string: A filter to define the first result.
ids string[]: A filter to search by a list of IDs.
orderBy string: A filter used to order the search results.
partialName string: A filter to search by the partial match of a name.
search string: A filter of terms used the search operation.
skip number: A filter to specify the number of items to skip in the response.
take number: A filter to specify the number of items to take (or return) in the response.
tenant string: A filter to search by a tenant ID.

certificates Sequence[GetCertificatesCertificate]: A list of certificates that match the filter(s).
id str: An auto-generated identifier that includes the timestamp when this data source was last modified.
space_id str: The space ID associated with this resource.
archived str: A filter to search for resources that have been archived.
first_result str: A filter to define the first result.
ids Sequence[str]: A filter to search by a list of IDs.
order_by str: A filter used to order the search results.
partial_name str: A filter to search by the partial match of a name.
search str: A filter of terms used the search operation.
skip float: A filter to specify the number of items to skip in the response.
take float: A filter to specify the number of items to take (or return) in the response.
tenant str: A filter to search by a tenant ID.

certificates List<Property Map>: A list of certificates that match the filter(s).
id String: An auto-generated identifier that includes the timestamp when this data source was last modified.
spaceId String: The space ID associated with this resource.
archived String: A filter to search for resources that have been archived.
firstResult String: A filter to define the first result.
ids List<String>: A filter to search by a list of IDs.
orderBy String: A filter used to order the search results.
partialName String: A filter to search by the partial match of a name.
search String: A filter of terms used the search operation.
skip Number: A filter to specify the number of items to skip in the response.
take Number: A filter to specify the number of items to take (or return) in the response.
tenant String: A filter to search by a tenant ID.