1. Packages
  2. Azure Classic
  3. API Docs
  4. core
  5. PortalTenantConfiguration

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.core.PortalTenantConfiguration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages Portal Tenant Configuration.

    Note: User has to be Contributor or Owner at scope / for managing this resource.

    Note: The Service Principal with Tenant Admin can be created by az ad sp create-for-rbac --name "<sp name>" --role="Contributor" --scopes="/".

    Note: The Service Principal can be granted Tenant Admin permission by az role assignment create --assignee "<app id>" --role "Contributor" --scope "/".

    Note: While assigning the role to the existing/new Service Principal at the Tenant Scope, the user assigning role must already have the Owner role assigned at the Tenant Scope.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.PortalTenantConfiguration("example", {privateMarkdownStorageEnforced: true});
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.PortalTenantConfiguration("example", private_markdown_storage_enforced=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := core.NewPortalTenantConfiguration(ctx, "example", &core.PortalTenantConfigurationArgs{
    			PrivateMarkdownStorageEnforced: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.PortalTenantConfiguration("example", new()
        {
            PrivateMarkdownStorageEnforced = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.PortalTenantConfiguration;
    import com.pulumi.azure.core.PortalTenantConfigurationArgs;
    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 example = new PortalTenantConfiguration("example", PortalTenantConfigurationArgs.builder()
                .privateMarkdownStorageEnforced(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:PortalTenantConfiguration
        properties:
          privateMarkdownStorageEnforced: true
    

    Create PortalTenantConfiguration Resource

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

    Constructor syntax

    new PortalTenantConfiguration(name: string, args: PortalTenantConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def PortalTenantConfiguration(resource_name: str,
                                  args: PortalTenantConfigurationArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PortalTenantConfiguration(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  private_markdown_storage_enforced: Optional[bool] = None)
    func NewPortalTenantConfiguration(ctx *Context, name string, args PortalTenantConfigurationArgs, opts ...ResourceOption) (*PortalTenantConfiguration, error)
    public PortalTenantConfiguration(string name, PortalTenantConfigurationArgs args, CustomResourceOptions? opts = null)
    public PortalTenantConfiguration(String name, PortalTenantConfigurationArgs args)
    public PortalTenantConfiguration(String name, PortalTenantConfigurationArgs args, CustomResourceOptions options)
    
    type: azure:core:PortalTenantConfiguration
    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 PortalTenantConfigurationArgs
    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 PortalTenantConfigurationArgs
    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 PortalTenantConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalTenantConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalTenantConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var portalTenantConfigurationResource = new Azure.Core.PortalTenantConfiguration("portalTenantConfigurationResource", new()
    {
        PrivateMarkdownStorageEnforced = false,
    });
    
    example, err := core.NewPortalTenantConfiguration(ctx, "portalTenantConfigurationResource", &core.PortalTenantConfigurationArgs{
    	PrivateMarkdownStorageEnforced: pulumi.Bool(false),
    })
    
    var portalTenantConfigurationResource = new PortalTenantConfiguration("portalTenantConfigurationResource", PortalTenantConfigurationArgs.builder()
        .privateMarkdownStorageEnforced(false)
        .build());
    
    portal_tenant_configuration_resource = azure.core.PortalTenantConfiguration("portalTenantConfigurationResource", private_markdown_storage_enforced=False)
    
    const portalTenantConfigurationResource = new azure.core.PortalTenantConfiguration("portalTenantConfigurationResource", {privateMarkdownStorageEnforced: false});
    
    type: azure:core:PortalTenantConfiguration
    properties:
        privateMarkdownStorageEnforced: false
    

    PortalTenantConfiguration Resource Properties

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

    Inputs

    The PortalTenantConfiguration resource accepts the following input properties:

    PrivateMarkdownStorageEnforced bool

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    PrivateMarkdownStorageEnforced bool

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    privateMarkdownStorageEnforced Boolean

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    privateMarkdownStorageEnforced boolean

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    private_markdown_storage_enforced bool

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    privateMarkdownStorageEnforced Boolean

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PortalTenantConfiguration Resource

    Get an existing PortalTenantConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PortalTenantConfigurationState, opts?: CustomResourceOptions): PortalTenantConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            private_markdown_storage_enforced: Optional[bool] = None) -> PortalTenantConfiguration
    func GetPortalTenantConfiguration(ctx *Context, name string, id IDInput, state *PortalTenantConfigurationState, opts ...ResourceOption) (*PortalTenantConfiguration, error)
    public static PortalTenantConfiguration Get(string name, Input<string> id, PortalTenantConfigurationState? state, CustomResourceOptions? opts = null)
    public static PortalTenantConfiguration get(String name, Output<String> id, PortalTenantConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    PrivateMarkdownStorageEnforced bool

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    PrivateMarkdownStorageEnforced bool

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    privateMarkdownStorageEnforced Boolean

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    privateMarkdownStorageEnforced boolean

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    private_markdown_storage_enforced bool

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    privateMarkdownStorageEnforced Boolean

    Is the private tile markdown storage which used to display custom dynamic and static content enabled?

    Note: When private_markdown_storage_enforced is set to true, only external storage configuration (URI) is allowed for Markdown tiles. Inline content configuration will be prohibited.

    Import

    Portal Tenant Configurations can be imported using the resource id, e.g.

    $ pulumi import azure:core/portalTenantConfiguration:PortalTenantConfiguration example /providers/Microsoft.Portal/tenantConfigurations/default
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi