Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. getFederatedAnsibleRepository
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

artifactory.getFederatedAnsibleRepository

Explore with Pulumi AI

artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

Retrieves a federated Ansible repository.

Example Usage

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

const federated_test_ansible_repo = artifactory.getFederatedAnsibleRepository({
    key: "federated-test-ansible-repo",
});
Copy
import pulumi
import pulumi_artifactory as artifactory

federated_test_ansible_repo = artifactory.get_federated_ansible_repository(key="federated-test-ansible-repo")
Copy
package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := artifactory.LookupFederatedAnsibleRepository(ctx, &artifactory.LookupFederatedAnsibleRepositoryArgs{
			Key: "federated-test-ansible-repo",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var federated_test_ansible_repo = Artifactory.GetFederatedAnsibleRepository.Invoke(new()
    {
        Key = "federated-test-ansible-repo",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.ArtifactoryFunctions;
import com.pulumi.artifactory.inputs.GetFederatedAnsibleRepositoryArgs;
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 federated-test-ansible-repo = ArtifactoryFunctions.getFederatedAnsibleRepository(GetFederatedAnsibleRepositoryArgs.builder()
            .key("federated-test-ansible-repo")
            .build());

    }
}
Copy
variables:
  federated-test-ansible-repo:
    fn::invoke:
      function: artifactory:getFederatedAnsibleRepository
      arguments:
        key: federated-test-ansible-repo
Copy

Using getFederatedAnsibleRepository

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 getFederatedAnsibleRepository(args: GetFederatedAnsibleRepositoryArgs, opts?: InvokeOptions): Promise<GetFederatedAnsibleRepositoryResult>
function getFederatedAnsibleRepositoryOutput(args: GetFederatedAnsibleRepositoryOutputArgs, opts?: InvokeOptions): Output<GetFederatedAnsibleRepositoryResult>
Copy
def get_federated_ansible_repository(archive_browsing_enabled: Optional[bool] = None,
                                     blacked_out: Optional[bool] = None,
                                     cdn_redirect: Optional[bool] = None,
                                     cleanup_on_delete: Optional[bool] = None,
                                     description: Optional[str] = None,
                                     disable_proxy: Optional[bool] = None,
                                     download_direct: Optional[bool] = None,
                                     excludes_pattern: Optional[str] = None,
                                     includes_pattern: Optional[str] = None,
                                     key: Optional[str] = None,
                                     members: Optional[Sequence[GetFederatedAnsibleRepositoryMember]] = None,
                                     notes: Optional[str] = None,
                                     primary_keypair_ref: Optional[str] = None,
                                     priority_resolution: Optional[bool] = None,
                                     project_environments: Optional[Sequence[str]] = None,
                                     project_key: Optional[str] = None,
                                     property_sets: Optional[Sequence[str]] = None,
                                     proxy: Optional[str] = None,
                                     repo_layout_ref: Optional[str] = None,
                                     xray_index: Optional[bool] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetFederatedAnsibleRepositoryResult
def get_federated_ansible_repository_output(archive_browsing_enabled: Optional[pulumi.Input[bool]] = None,
                                     blacked_out: Optional[pulumi.Input[bool]] = None,
                                     cdn_redirect: Optional[pulumi.Input[bool]] = None,
                                     cleanup_on_delete: Optional[pulumi.Input[bool]] = None,
                                     description: Optional[pulumi.Input[str]] = None,
                                     disable_proxy: Optional[pulumi.Input[bool]] = None,
                                     download_direct: Optional[pulumi.Input[bool]] = None,
                                     excludes_pattern: Optional[pulumi.Input[str]] = None,
                                     includes_pattern: Optional[pulumi.Input[str]] = None,
                                     key: Optional[pulumi.Input[str]] = None,
                                     members: Optional[pulumi.Input[Sequence[pulumi.Input[GetFederatedAnsibleRepositoryMemberArgs]]]] = None,
                                     notes: Optional[pulumi.Input[str]] = None,
                                     primary_keypair_ref: Optional[pulumi.Input[str]] = None,
                                     priority_resolution: Optional[pulumi.Input[bool]] = None,
                                     project_environments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                     project_key: Optional[pulumi.Input[str]] = None,
                                     property_sets: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                     proxy: Optional[pulumi.Input[str]] = None,
                                     repo_layout_ref: Optional[pulumi.Input[str]] = None,
                                     xray_index: Optional[pulumi.Input[bool]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetFederatedAnsibleRepositoryResult]
Copy
func LookupFederatedAnsibleRepository(ctx *Context, args *LookupFederatedAnsibleRepositoryArgs, opts ...InvokeOption) (*LookupFederatedAnsibleRepositoryResult, error)
func LookupFederatedAnsibleRepositoryOutput(ctx *Context, args *LookupFederatedAnsibleRepositoryOutputArgs, opts ...InvokeOption) LookupFederatedAnsibleRepositoryResultOutput
Copy

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

public static class GetFederatedAnsibleRepository 
{
    public static Task<GetFederatedAnsibleRepositoryResult> InvokeAsync(GetFederatedAnsibleRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedAnsibleRepositoryResult> Invoke(GetFederatedAnsibleRepositoryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFederatedAnsibleRepositoryResult> getFederatedAnsibleRepository(GetFederatedAnsibleRepositoryArgs args, InvokeOptions options)
public static Output<GetFederatedAnsibleRepositoryResult> getFederatedAnsibleRepository(GetFederatedAnsibleRepositoryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: artifactory:index/getFederatedAnsibleRepository:getFederatedAnsibleRepository
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Key
This property is required.
Changes to this property will trigger replacement.
string
the identity key of the repo.
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
CleanupOnDelete bool
Description string
DisableProxy bool
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Members List<GetFederatedAnsibleRepositoryMember>
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
Notes string
PrimaryKeypairRef string
PriorityResolution bool
ProjectEnvironments List<string>
ProjectKey string
PropertySets List<string>
Proxy string
Proxy key from Artifactory Proxies settings.
RepoLayoutRef string
XrayIndex bool
Key
This property is required.
Changes to this property will trigger replacement.
string
the identity key of the repo.
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
CleanupOnDelete bool
Description string
DisableProxy bool
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Members []GetFederatedAnsibleRepositoryMember
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
Notes string
PrimaryKeypairRef string
PriorityResolution bool
ProjectEnvironments []string
ProjectKey string
PropertySets []string
Proxy string
Proxy key from Artifactory Proxies settings.
RepoLayoutRef string
XrayIndex bool
key
This property is required.
Changes to this property will trigger replacement.
String
the identity key of the repo.
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
cleanupOnDelete Boolean
description String
disableProxy Boolean
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
downloadDirect Boolean
excludesPattern String
includesPattern String
members List<GetFederatedAnsibleRepositoryMember>
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes String
primaryKeypairRef String
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
proxy String
Proxy key from Artifactory Proxies settings.
repoLayoutRef String
xrayIndex Boolean
key
This property is required.
Changes to this property will trigger replacement.
string
the identity key of the repo.
archiveBrowsingEnabled boolean
blackedOut boolean
cdnRedirect boolean
cleanupOnDelete boolean
description string
disableProxy boolean
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
downloadDirect boolean
excludesPattern string
includesPattern string
members GetFederatedAnsibleRepositoryMember[]
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes string
primaryKeypairRef string
priorityResolution boolean
projectEnvironments string[]
projectKey string
propertySets string[]
proxy string
Proxy key from Artifactory Proxies settings.
repoLayoutRef string
xrayIndex boolean
key
This property is required.
Changes to this property will trigger replacement.
str
the identity key of the repo.
archive_browsing_enabled bool
blacked_out bool
cdn_redirect bool
cleanup_on_delete bool
description str
disable_proxy bool
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
download_direct bool
excludes_pattern str
includes_pattern str
members Sequence[GetFederatedAnsibleRepositoryMember]
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes str
primary_keypair_ref str
priority_resolution bool
project_environments Sequence[str]
project_key str
property_sets Sequence[str]
proxy str
Proxy key from Artifactory Proxies settings.
repo_layout_ref str
xray_index bool
key
This property is required.
Changes to this property will trigger replacement.
String
the identity key of the repo.
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
cleanupOnDelete Boolean
description String
disableProxy Boolean
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
downloadDirect Boolean
excludesPattern String
includesPattern String
members List<Property Map>
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes String
primaryKeypairRef String
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
proxy String
Proxy key from Artifactory Proxies settings.
repoLayoutRef String
xrayIndex Boolean

getFederatedAnsibleRepository Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Key string
PackageType string
ProjectEnvironments List<string>
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
CleanupOnDelete bool
Description string
DisableProxy bool
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Members List<GetFederatedAnsibleRepositoryMember>
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
Notes string
PrimaryKeypairRef string
PriorityResolution bool
ProjectKey string
PropertySets List<string>
Proxy string
Proxy key from Artifactory Proxies settings.
RepoLayoutRef string
XrayIndex bool
Id string
The provider-assigned unique ID for this managed resource.
Key string
PackageType string
ProjectEnvironments []string
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
CleanupOnDelete bool
Description string
DisableProxy bool
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Members []GetFederatedAnsibleRepositoryMember
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
Notes string
PrimaryKeypairRef string
PriorityResolution bool
ProjectKey string
PropertySets []string
Proxy string
Proxy key from Artifactory Proxies settings.
RepoLayoutRef string
XrayIndex bool
id String
The provider-assigned unique ID for this managed resource.
key String
packageType String
projectEnvironments List<String>
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
cleanupOnDelete Boolean
description String
disableProxy Boolean
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
downloadDirect Boolean
excludesPattern String
includesPattern String
members List<GetFederatedAnsibleRepositoryMember>
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes String
primaryKeypairRef String
priorityResolution Boolean
projectKey String
propertySets List<String>
proxy String
Proxy key from Artifactory Proxies settings.
repoLayoutRef String
xrayIndex Boolean
id string
The provider-assigned unique ID for this managed resource.
key string
packageType string
projectEnvironments string[]
archiveBrowsingEnabled boolean
blackedOut boolean
cdnRedirect boolean
cleanupOnDelete boolean
description string
disableProxy boolean
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
downloadDirect boolean
excludesPattern string
includesPattern string
members GetFederatedAnsibleRepositoryMember[]
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes string
primaryKeypairRef string
priorityResolution boolean
projectKey string
propertySets string[]
proxy string
Proxy key from Artifactory Proxies settings.
repoLayoutRef string
xrayIndex boolean
id str
The provider-assigned unique ID for this managed resource.
key str
package_type str
project_environments Sequence[str]
archive_browsing_enabled bool
blacked_out bool
cdn_redirect bool
cleanup_on_delete bool
description str
disable_proxy bool
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
download_direct bool
excludes_pattern str
includes_pattern str
members Sequence[GetFederatedAnsibleRepositoryMember]
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes str
primary_keypair_ref str
priority_resolution bool
project_key str
property_sets Sequence[str]
proxy str
Proxy key from Artifactory Proxies settings.
repo_layout_ref str
xray_index bool
id String
The provider-assigned unique ID for this managed resource.
key String
packageType String
projectEnvironments List<String>
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
cleanupOnDelete Boolean
description String
disableProxy Boolean
When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
downloadDirect Boolean
excludesPattern String
includesPattern String
members List<Property Map>
The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
notes String
primaryKeypairRef String
priorityResolution Boolean
projectKey String
propertySets List<String>
proxy String
Proxy key from Artifactory Proxies settings.
repoLayoutRef String
xrayIndex Boolean

Supporting Types

GetFederatedAnsibleRepositoryMember

Enabled This property is required. bool
Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
Url This property is required. string
Full URL to ending with the repository name.
AccessToken string
Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
Enabled This property is required. bool
Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
Url This property is required. string
Full URL to ending with the repository name.
AccessToken string
Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
enabled This property is required. Boolean
Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
url This property is required. String
Full URL to ending with the repository name.
accessToken String
Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
enabled This property is required. boolean
Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
url This property is required. string
Full URL to ending with the repository name.
accessToken string
Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
enabled This property is required. bool
Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
url This property is required. str
Full URL to ending with the repository name.
access_token str
Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
enabled This property is required. Boolean
Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
url This property is required. String
Full URL to ending with the repository name.
accessToken String
Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.

Package Details

Repository
artifactory pulumi/pulumi-artifactory
License
Apache-2.0
Notes
This Pulumi package is based on the artifactory Terraform Provider.
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory