Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. datacatalog
  5. getADCCatalog
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.datacatalog.getADCCatalog

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog. Azure REST API version: 2016-03-30.

Using getADCCatalog

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 getADCCatalog(args: GetADCCatalogArgs, opts?: InvokeOptions): Promise<GetADCCatalogResult>
function getADCCatalogOutput(args: GetADCCatalogOutputArgs, opts?: InvokeOptions): Output<GetADCCatalogResult>
Copy
def get_adc_catalog(catalog_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetADCCatalogResult
def get_adc_catalog_output(catalog_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetADCCatalogResult]
Copy
func LookupADCCatalog(ctx *Context, args *LookupADCCatalogArgs, opts ...InvokeOption) (*LookupADCCatalogResult, error)
func LookupADCCatalogOutput(ctx *Context, args *LookupADCCatalogOutputArgs, opts ...InvokeOption) LookupADCCatalogResultOutput
Copy

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

public static class GetADCCatalog 
{
    public static Task<GetADCCatalogResult> InvokeAsync(GetADCCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetADCCatalogResult> Invoke(GetADCCatalogInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetADCCatalogResult> getADCCatalog(GetADCCatalogArgs args, InvokeOptions options)
public static Output<GetADCCatalogResult> getADCCatalog(GetADCCatalogArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:datacatalog:getADCCatalog
  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 data catalog in the specified subscription and resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the data catalog in the specified subscription and resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
The name of the data catalog in the specified subscription and resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the data catalog in the specified subscription and resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the data catalog in the specified subscription and resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
The name of the data catalog in the specified subscription and resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.

getADCCatalog Result

The following output properties are available:

Id string
Resource Id
Name string
Resource name
Type string
Resource type
Admins List<Pulumi.AzureNative.DataCatalog.Outputs.PrincipalsResponse>
Azure data catalog admin list.
EnableAutomaticUnitAdjustment bool
Automatic unit adjustment enabled or not.
Etag string
Resource etag
Location string
Resource location
Sku string
Azure data catalog SKU.
SuccessfullyProvisioned bool
Azure data catalog provision status.
Tags Dictionary<string, string>
Resource tags
Units int
Azure data catalog units.
Users List<Pulumi.AzureNative.DataCatalog.Outputs.PrincipalsResponse>
Azure data catalog user list.
Id string
Resource Id
Name string
Resource name
Type string
Resource type
Admins []PrincipalsResponse
Azure data catalog admin list.
EnableAutomaticUnitAdjustment bool
Automatic unit adjustment enabled or not.
Etag string
Resource etag
Location string
Resource location
Sku string
Azure data catalog SKU.
SuccessfullyProvisioned bool
Azure data catalog provision status.
Tags map[string]string
Resource tags
Units int
Azure data catalog units.
Users []PrincipalsResponse
Azure data catalog user list.
id String
Resource Id
name String
Resource name
type String
Resource type
admins List<PrincipalsResponse>
Azure data catalog admin list.
enableAutomaticUnitAdjustment Boolean
Automatic unit adjustment enabled or not.
etag String
Resource etag
location String
Resource location
sku String
Azure data catalog SKU.
successfullyProvisioned Boolean
Azure data catalog provision status.
tags Map<String,String>
Resource tags
units Integer
Azure data catalog units.
users List<PrincipalsResponse>
Azure data catalog user list.
id string
Resource Id
name string
Resource name
type string
Resource type
admins PrincipalsResponse[]
Azure data catalog admin list.
enableAutomaticUnitAdjustment boolean
Automatic unit adjustment enabled or not.
etag string
Resource etag
location string
Resource location
sku string
Azure data catalog SKU.
successfullyProvisioned boolean
Azure data catalog provision status.
tags {[key: string]: string}
Resource tags
units number
Azure data catalog units.
users PrincipalsResponse[]
Azure data catalog user list.
id str
Resource Id
name str
Resource name
type str
Resource type
admins Sequence[PrincipalsResponse]
Azure data catalog admin list.
enable_automatic_unit_adjustment bool
Automatic unit adjustment enabled or not.
etag str
Resource etag
location str
Resource location
sku str
Azure data catalog SKU.
successfully_provisioned bool
Azure data catalog provision status.
tags Mapping[str, str]
Resource tags
units int
Azure data catalog units.
users Sequence[PrincipalsResponse]
Azure data catalog user list.
id String
Resource Id
name String
Resource name
type String
Resource type
admins List<Property Map>
Azure data catalog admin list.
enableAutomaticUnitAdjustment Boolean
Automatic unit adjustment enabled or not.
etag String
Resource etag
location String
Resource location
sku String
Azure data catalog SKU.
successfullyProvisioned Boolean
Azure data catalog provision status.
tags Map<String>
Resource tags
units Number
Azure data catalog units.
users List<Property Map>
Azure data catalog user list.

Supporting Types

PrincipalsResponse

ObjectId string
Object Id for the user
Upn string
UPN of the user.
ObjectId string
Object Id for the user
Upn string
UPN of the user.
objectId String
Object Id for the user
upn String
UPN of the user.
objectId string
Object Id for the user
upn string
UPN of the user.
object_id str
Object Id for the user
upn str
UPN of the user.
objectId String
Object Id for the user
upn String
UPN of the user.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native