1. Packages
  2. Azure Native
  3. API Docs
  4. datacatalog
  5. ADCCatalog
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi

azure-native.datacatalog.ADCCatalog

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi

    Azure Data Catalog. Azure REST API version: 2016-03-30. Prior API version in Azure Native 1.x: 2016-03-30.

    Example Usage

    Create Azure Data Catalog Service

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var adcCatalog = new AzureNative.DataCatalog.ADCCatalog("adcCatalog", new()
        {
            Admins = new[]
            {
                new AzureNative.DataCatalog.Inputs.PrincipalsArgs
                {
                    ObjectId = "99999999-9999-9999-999999999999",
                    Upn = "myupn@microsoft.com",
                },
            },
            CatalogName = "exampleCatalog",
            EnableAutomaticUnitAdjustment = false,
            Location = "North US",
            ResourceGroupName = "exampleResourceGroup",
            Sku = AzureNative.DataCatalog.SkuType.Standard,
            Tags = 
            {
                { "mykey", "myvalue" },
                { "mykey2", "myvalue2" },
            },
            Units = 1,
            Users = new[]
            {
                new AzureNative.DataCatalog.Inputs.PrincipalsArgs
                {
                    ObjectId = "99999999-9999-9999-999999999999",
                    Upn = "myupn@microsoft.com",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	datacatalog "github.com/pulumi/pulumi-azure-native-sdk/datacatalog/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := datacatalog.NewADCCatalog(ctx, "adcCatalog", &datacatalog.ADCCatalogArgs{
    			Admins: datacatalog.PrincipalsArray{
    				&datacatalog.PrincipalsArgs{
    					ObjectId: pulumi.String("99999999-9999-9999-999999999999"),
    					Upn:      pulumi.String("myupn@microsoft.com"),
    				},
    			},
    			CatalogName:                   pulumi.String("exampleCatalog"),
    			EnableAutomaticUnitAdjustment: pulumi.Bool(false),
    			Location:                      pulumi.String("North US"),
    			ResourceGroupName:             pulumi.String("exampleResourceGroup"),
    			Sku:                           pulumi.String(datacatalog.SkuTypeStandard),
    			Tags: pulumi.StringMap{
    				"mykey":  pulumi.String("myvalue"),
    				"mykey2": pulumi.String("myvalue2"),
    			},
    			Units: pulumi.Int(1),
    			Users: datacatalog.PrincipalsArray{
    				&datacatalog.PrincipalsArgs{
    					ObjectId: pulumi.String("99999999-9999-9999-999999999999"),
    					Upn:      pulumi.String("myupn@microsoft.com"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.datacatalog.ADCCatalog;
    import com.pulumi.azurenative.datacatalog.ADCCatalogArgs;
    import com.pulumi.azurenative.datacatalog.inputs.PrincipalsArgs;
    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) {
            var adcCatalog = new ADCCatalog("adcCatalog", ADCCatalogArgs.builder()
                .admins(PrincipalsArgs.builder()
                    .objectId("99999999-9999-9999-999999999999")
                    .upn("myupn@microsoft.com")
                    .build())
                .catalogName("exampleCatalog")
                .enableAutomaticUnitAdjustment(false)
                .location("North US")
                .resourceGroupName("exampleResourceGroup")
                .sku("Standard")
                .tags(Map.ofEntries(
                    Map.entry("mykey", "myvalue"),
                    Map.entry("mykey2", "myvalue2")
                ))
                .units(1)
                .users(PrincipalsArgs.builder()
                    .objectId("99999999-9999-9999-999999999999")
                    .upn("myupn@microsoft.com")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    adc_catalog = azure_native.datacatalog.ADCCatalog("adcCatalog",
        admins=[{
            "object_id": "99999999-9999-9999-999999999999",
            "upn": "myupn@microsoft.com",
        }],
        catalog_name="exampleCatalog",
        enable_automatic_unit_adjustment=False,
        location="North US",
        resource_group_name="exampleResourceGroup",
        sku=azure_native.datacatalog.SkuType.STANDARD,
        tags={
            "mykey": "myvalue",
            "mykey2": "myvalue2",
        },
        units=1,
        users=[{
            "object_id": "99999999-9999-9999-999999999999",
            "upn": "myupn@microsoft.com",
        }])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const adcCatalog = new azure_native.datacatalog.ADCCatalog("adcCatalog", {
        admins: [{
            objectId: "99999999-9999-9999-999999999999",
            upn: "myupn@microsoft.com",
        }],
        catalogName: "exampleCatalog",
        enableAutomaticUnitAdjustment: false,
        location: "North US",
        resourceGroupName: "exampleResourceGroup",
        sku: azure_native.datacatalog.SkuType.Standard,
        tags: {
            mykey: "myvalue",
            mykey2: "myvalue2",
        },
        units: 1,
        users: [{
            objectId: "99999999-9999-9999-999999999999",
            upn: "myupn@microsoft.com",
        }],
    });
    
    resources:
      adcCatalog:
        type: azure-native:datacatalog:ADCCatalog
        properties:
          admins:
            - objectId: 99999999-9999-9999-999999999999
              upn: myupn@microsoft.com
          catalogName: exampleCatalog
          enableAutomaticUnitAdjustment: false
          location: North US
          resourceGroupName: exampleResourceGroup
          sku: Standard
          tags:
            mykey: myvalue
            mykey2: myvalue2
          units: 1
          users:
            - objectId: 99999999-9999-9999-999999999999
              upn: myupn@microsoft.com
    

    Create ADCCatalog Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ADCCatalog(name: string, args: ADCCatalogArgs, opts?: CustomResourceOptions);
    @overload
    def ADCCatalog(resource_name: str,
                   args: ADCCatalogArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ADCCatalog(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   admins: Optional[Sequence[PrincipalsArgs]] = None,
                   catalog_name: Optional[str] = None,
                   enable_automatic_unit_adjustment: Optional[bool] = None,
                   location: Optional[str] = None,
                   sku: Optional[Union[str, SkuType]] = None,
                   successfully_provisioned: Optional[bool] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   units: Optional[int] = None,
                   users: Optional[Sequence[PrincipalsArgs]] = None)
    func NewADCCatalog(ctx *Context, name string, args ADCCatalogArgs, opts ...ResourceOption) (*ADCCatalog, error)
    public ADCCatalog(string name, ADCCatalogArgs args, CustomResourceOptions? opts = null)
    public ADCCatalog(String name, ADCCatalogArgs args)
    public ADCCatalog(String name, ADCCatalogArgs args, CustomResourceOptions options)
    
    type: azure-native:datacatalog:ADCCatalog
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ADCCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ADCCatalogArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ADCCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ADCCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ADCCatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var adccatalogResource = new AzureNative.DataCatalog.ADCCatalog("adccatalogResource", new()
    {
        ResourceGroupName = "string",
        Admins = new[]
        {
            new AzureNative.DataCatalog.Inputs.PrincipalsArgs
            {
                ObjectId = "string",
                Upn = "string",
            },
        },
        CatalogName = "string",
        EnableAutomaticUnitAdjustment = false,
        Location = "string",
        Sku = "string",
        SuccessfullyProvisioned = false,
        Tags = 
        {
            { "string", "string" },
        },
        Units = 0,
        Users = new[]
        {
            new AzureNative.DataCatalog.Inputs.PrincipalsArgs
            {
                ObjectId = "string",
                Upn = "string",
            },
        },
    });
    
    example, err := datacatalog.NewADCCatalog(ctx, "adccatalogResource", &datacatalog.ADCCatalogArgs{
    	ResourceGroupName: pulumi.String("string"),
    	Admins: datacatalog.PrincipalsArray{
    		&datacatalog.PrincipalsArgs{
    			ObjectId: pulumi.String("string"),
    			Upn:      pulumi.String("string"),
    		},
    	},
    	CatalogName:                   pulumi.String("string"),
    	EnableAutomaticUnitAdjustment: pulumi.Bool(false),
    	Location:                      pulumi.String("string"),
    	Sku:                           pulumi.String("string"),
    	SuccessfullyProvisioned:       pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Units: pulumi.Int(0),
    	Users: datacatalog.PrincipalsArray{
    		&datacatalog.PrincipalsArgs{
    			ObjectId: pulumi.String("string"),
    			Upn:      pulumi.String("string"),
    		},
    	},
    })
    
    var adccatalogResource = new ADCCatalog("adccatalogResource", ADCCatalogArgs.builder()
        .resourceGroupName("string")
        .admins(PrincipalsArgs.builder()
            .objectId("string")
            .upn("string")
            .build())
        .catalogName("string")
        .enableAutomaticUnitAdjustment(false)
        .location("string")
        .sku("string")
        .successfullyProvisioned(false)
        .tags(Map.of("string", "string"))
        .units(0)
        .users(PrincipalsArgs.builder()
            .objectId("string")
            .upn("string")
            .build())
        .build());
    
    adccatalog_resource = azure_native.datacatalog.ADCCatalog("adccatalogResource",
        resource_group_name="string",
        admins=[{
            "object_id": "string",
            "upn": "string",
        }],
        catalog_name="string",
        enable_automatic_unit_adjustment=False,
        location="string",
        sku="string",
        successfully_provisioned=False,
        tags={
            "string": "string",
        },
        units=0,
        users=[{
            "object_id": "string",
            "upn": "string",
        }])
    
    const adccatalogResource = new azure_native.datacatalog.ADCCatalog("adccatalogResource", {
        resourceGroupName: "string",
        admins: [{
            objectId: "string",
            upn: "string",
        }],
        catalogName: "string",
        enableAutomaticUnitAdjustment: false,
        location: "string",
        sku: "string",
        successfullyProvisioned: false,
        tags: {
            string: "string",
        },
        units: 0,
        users: [{
            objectId: "string",
            upn: "string",
        }],
    });
    
    type: azure-native:datacatalog:ADCCatalog
    properties:
        admins:
            - objectId: string
              upn: string
        catalogName: string
        enableAutomaticUnitAdjustment: false
        location: string
        resourceGroupName: string
        sku: string
        successfullyProvisioned: false
        tags:
            string: string
        units: 0
        users:
            - objectId: string
              upn: string
    

    ADCCatalog Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ADCCatalog resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    Admins List<Pulumi.AzureNative.DataCatalog.Inputs.Principals>
    Azure data catalog admin list.
    CatalogName string
    The name of the data catalog in the specified subscription and resource group.
    EnableAutomaticUnitAdjustment bool
    Automatic unit adjustment enabled or not.
    Location string
    Resource location
    Sku string | Pulumi.AzureNative.DataCatalog.SkuType
    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.Inputs.Principals>
    Azure data catalog user list.
    ResourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    Admins []PrincipalsArgs
    Azure data catalog admin list.
    CatalogName string
    The name of the data catalog in the specified subscription and resource group.
    EnableAutomaticUnitAdjustment bool
    Automatic unit adjustment enabled or not.
    Location string
    Resource location
    Sku string | SkuType
    Azure data catalog SKU.
    SuccessfullyProvisioned bool
    Azure data catalog provision status.
    Tags map[string]string
    Resource tags
    Units int
    Azure data catalog units.
    Users []PrincipalsArgs
    Azure data catalog user list.
    resourceGroupName String
    The name of the resource group within the user's subscription. The name is case insensitive.
    admins List<Principals>
    Azure data catalog admin list.
    catalogName String
    The name of the data catalog in the specified subscription and resource group.
    enableAutomaticUnitAdjustment Boolean
    Automatic unit adjustment enabled or not.
    location String
    Resource location
    sku String | SkuType
    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<Principals>
    Azure data catalog user list.
    resourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    admins Principals[]
    Azure data catalog admin list.
    catalogName string
    The name of the data catalog in the specified subscription and resource group.
    enableAutomaticUnitAdjustment boolean
    Automatic unit adjustment enabled or not.
    location string
    Resource location
    sku string | SkuType
    Azure data catalog SKU.
    successfullyProvisioned boolean
    Azure data catalog provision status.
    tags {[key: string]: string}
    Resource tags
    units number
    Azure data catalog units.
    users Principals[]
    Azure data catalog user list.
    resource_group_name str
    The name of the resource group within the user's subscription. The name is case insensitive.
    admins Sequence[PrincipalsArgs]
    Azure data catalog admin list.
    catalog_name str
    The name of the data catalog in the specified subscription and resource group.
    enable_automatic_unit_adjustment bool
    Automatic unit adjustment enabled or not.
    location str
    Resource location
    sku str | SkuType
    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[PrincipalsArgs]
    Azure data catalog user list.
    resourceGroupName String
    The name of the resource group within the user's subscription. The name is case insensitive.
    admins List<Property Map>
    Azure data catalog admin list.
    catalogName String
    The name of the data catalog in the specified subscription and resource group.
    enableAutomaticUnitAdjustment Boolean
    Automatic unit adjustment enabled or not.
    location String
    Resource location
    sku String | "Free" | "Standard"
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ADCCatalog resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    Etag string
    Resource etag
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    Etag string
    Resource etag
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    etag String
    Resource etag
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    type string
    Resource type
    etag string
    Resource etag
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    type str
    Resource type
    etag str
    Resource etag
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    etag String
    Resource etag

    Supporting Types

    Principals, PrincipalsArgs

    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.

    PrincipalsResponse, PrincipalsResponseArgs

    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.

    SkuType, SkuTypeArgs

    Free
    Free
    Standard
    Standard
    SkuTypeFree
    Free
    SkuTypeStandard
    Standard
    Free
    Free
    Standard
    Standard
    Free
    Free
    Standard
    Standard
    FREE
    Free
    STANDARD
    Standard
    "Free"
    Free
    "Standard"
    Standard

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:datacatalog:ADCCatalog exampleCatalog /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataCatalog/catalogs/{catalogName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi