Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devcenter
  5. getCatalog
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devcenter.getCatalog

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a catalog

Uses Azure REST API version 2024-02-01.

Other available API versions: 2023-04-01, 2023-08-01-preview, 2023-10-01-preview, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native devcenter [ApiVersion]. See the version guide for details.

Using getCatalog

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 getCatalog(args: GetCatalogArgs, opts?: InvokeOptions): Promise<GetCatalogResult>
function getCatalogOutput(args: GetCatalogOutputArgs, opts?: InvokeOptions): Output<GetCatalogResult>
Copy
def get_catalog(catalog_name: Optional[str] = None,
                dev_center_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCatalogResult
def get_catalog_output(catalog_name: Optional[pulumi.Input[str]] = None,
                dev_center_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCatalogResult]
Copy
func LookupCatalog(ctx *Context, args *LookupCatalogArgs, opts ...InvokeOption) (*LookupCatalogResult, error)
func LookupCatalogOutput(ctx *Context, args *LookupCatalogOutputArgs, opts ...InvokeOption) LookupCatalogResultOutput
Copy

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

public static class GetCatalog 
{
    public static Task<GetCatalogResult> InvokeAsync(GetCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogResult> Invoke(GetCatalogInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)
public static Output<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devcenter:getCatalog
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CatalogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Catalog.
DevCenterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the devcenter.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Catalog.
DevCenterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the devcenter.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Catalog.
devCenterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the devcenter.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Catalog.
devCenterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the devcenter.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Catalog.
dev_center_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the devcenter.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Catalog.
devCenterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the devcenter.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getCatalog Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ConnectionState string
The connection state of the catalog.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LastConnectionTime string
When the catalog was last connected.
LastSyncStats Pulumi.AzureNative.DevCenter.Outputs.SyncStatsResponse
Stats of the latest synchronization.
LastSyncTime string
When the catalog was last synced.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
SyncState string
The synchronization state of the catalog.
SystemData Pulumi.AzureNative.DevCenter.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AdoGit Pulumi.AzureNative.DevCenter.Outputs.GitCatalogResponse
Properties for an Azure DevOps catalog type.
GitHub Pulumi.AzureNative.DevCenter.Outputs.GitCatalogResponse
Properties for a GitHub catalog type.
SyncType string
Indicates the type of sync that is configured for the catalog.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
ConnectionState string
The connection state of the catalog.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LastConnectionTime string
When the catalog was last connected.
LastSyncStats SyncStatsResponse
Stats of the latest synchronization.
LastSyncTime string
When the catalog was last synced.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
SyncState string
The synchronization state of the catalog.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AdoGit GitCatalogResponse
Properties for an Azure DevOps catalog type.
GitHub GitCatalogResponse
Properties for a GitHub catalog type.
SyncType string
Indicates the type of sync that is configured for the catalog.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
connectionState String
The connection state of the catalog.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastConnectionTime String
When the catalog was last connected.
lastSyncStats SyncStatsResponse
Stats of the latest synchronization.
lastSyncTime String
When the catalog was last synced.
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
syncState String
The synchronization state of the catalog.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
adoGit GitCatalogResponse
Properties for an Azure DevOps catalog type.
gitHub GitCatalogResponse
Properties for a GitHub catalog type.
syncType String
Indicates the type of sync that is configured for the catalog.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
connectionState string
The connection state of the catalog.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastConnectionTime string
When the catalog was last connected.
lastSyncStats SyncStatsResponse
Stats of the latest synchronization.
lastSyncTime string
When the catalog was last synced.
name string
The name of the resource
provisioningState string
The provisioning state of the resource.
syncState string
The synchronization state of the catalog.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
adoGit GitCatalogResponse
Properties for an Azure DevOps catalog type.
gitHub GitCatalogResponse
Properties for a GitHub catalog type.
syncType string
Indicates the type of sync that is configured for the catalog.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
connection_state str
The connection state of the catalog.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
last_connection_time str
When the catalog was last connected.
last_sync_stats SyncStatsResponse
Stats of the latest synchronization.
last_sync_time str
When the catalog was last synced.
name str
The name of the resource
provisioning_state str
The provisioning state of the resource.
sync_state str
The synchronization state of the catalog.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ado_git GitCatalogResponse
Properties for an Azure DevOps catalog type.
git_hub GitCatalogResponse
Properties for a GitHub catalog type.
sync_type str
Indicates the type of sync that is configured for the catalog.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
connectionState String
The connection state of the catalog.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastConnectionTime String
When the catalog was last connected.
lastSyncStats Property Map
Stats of the latest synchronization.
lastSyncTime String
When the catalog was last synced.
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
syncState String
The synchronization state of the catalog.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
adoGit Property Map
Properties for an Azure DevOps catalog type.
gitHub Property Map
Properties for a GitHub catalog type.
syncType String
Indicates the type of sync that is configured for the catalog.
tags Map<String>
Resource tags.

Supporting Types

GitCatalogResponse

Branch string
Git branch.
Path string
The folder where the catalog items can be found inside the repository.
SecretIdentifier string
A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
Uri string
Git URI.
Branch string
Git branch.
Path string
The folder where the catalog items can be found inside the repository.
SecretIdentifier string
A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
Uri string
Git URI.
branch String
Git branch.
path String
The folder where the catalog items can be found inside the repository.
secretIdentifier String
A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
uri String
Git URI.
branch string
Git branch.
path string
The folder where the catalog items can be found inside the repository.
secretIdentifier string
A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
uri string
Git URI.
branch str
Git branch.
path str
The folder where the catalog items can be found inside the repository.
secret_identifier str
A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
uri str
Git URI.
branch String
Git branch.
path String
The folder where the catalog items can be found inside the repository.
secretIdentifier String
A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
uri String
Git URI.

SyncStatsResponse

Added This property is required. int
Count of catalog items added during synchronization.
Removed This property is required. int
Count of catalog items removed during synchronization.
SynchronizationErrors This property is required. int
Count of synchronization errors that occured during synchronization.
Unchanged This property is required. int
Count of catalog items that were unchanged during synchronization.
Updated This property is required. int
Count of catalog items updated during synchronization.
ValidationErrors This property is required. int
Count of catalog items that had validation errors during synchronization.
SyncedCatalogItemTypes List<string>
Indicates catalog item types that were synced.
Added This property is required. int
Count of catalog items added during synchronization.
Removed This property is required. int
Count of catalog items removed during synchronization.
SynchronizationErrors This property is required. int
Count of synchronization errors that occured during synchronization.
Unchanged This property is required. int
Count of catalog items that were unchanged during synchronization.
Updated This property is required. int
Count of catalog items updated during synchronization.
ValidationErrors This property is required. int
Count of catalog items that had validation errors during synchronization.
SyncedCatalogItemTypes []string
Indicates catalog item types that were synced.
added This property is required. Integer
Count of catalog items added during synchronization.
removed This property is required. Integer
Count of catalog items removed during synchronization.
synchronizationErrors This property is required. Integer
Count of synchronization errors that occured during synchronization.
unchanged This property is required. Integer
Count of catalog items that were unchanged during synchronization.
updated This property is required. Integer
Count of catalog items updated during synchronization.
validationErrors This property is required. Integer
Count of catalog items that had validation errors during synchronization.
syncedCatalogItemTypes List<String>
Indicates catalog item types that were synced.
added This property is required. number
Count of catalog items added during synchronization.
removed This property is required. number
Count of catalog items removed during synchronization.
synchronizationErrors This property is required. number
Count of synchronization errors that occured during synchronization.
unchanged This property is required. number
Count of catalog items that were unchanged during synchronization.
updated This property is required. number
Count of catalog items updated during synchronization.
validationErrors This property is required. number
Count of catalog items that had validation errors during synchronization.
syncedCatalogItemTypes string[]
Indicates catalog item types that were synced.
added This property is required. int
Count of catalog items added during synchronization.
removed This property is required. int
Count of catalog items removed during synchronization.
synchronization_errors This property is required. int
Count of synchronization errors that occured during synchronization.
unchanged This property is required. int
Count of catalog items that were unchanged during synchronization.
updated This property is required. int
Count of catalog items updated during synchronization.
validation_errors This property is required. int
Count of catalog items that had validation errors during synchronization.
synced_catalog_item_types Sequence[str]
Indicates catalog item types that were synced.
added This property is required. Number
Count of catalog items added during synchronization.
removed This property is required. Number
Count of catalog items removed during synchronization.
synchronizationErrors This property is required. Number
Count of synchronization errors that occured during synchronization.
unchanged This property is required. Number
Count of catalog items that were unchanged during synchronization.
updated This property is required. Number
Count of catalog items updated during synchronization.
validationErrors This property is required. Number
Count of catalog items that had validation errors during synchronization.
syncedCatalogItemTypes List<String>
Indicates catalog item types that were synced.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native