1. Packages
  2. Mso Provider
  3. API Docs
  4. Tenant
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.Tenant

Explore with Pulumi AI

Create Tenant Resource

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

Constructor syntax

new Tenant(name: string, args: TenantArgs, opts?: CustomResourceOptions);
@overload
def Tenant(resource_name: str,
           args: TenantArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Tenant(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           orchestrator_only: Optional[bool] = None,
           site_associations: Optional[Sequence[TenantSiteAssociationArgs]] = None,
           tenant_id: Optional[str] = None,
           user_associations: Optional[Sequence[TenantUserAssociationArgs]] = None)
func NewTenant(ctx *Context, name string, args TenantArgs, opts ...ResourceOption) (*Tenant, error)
public Tenant(string name, TenantArgs args, CustomResourceOptions? opts = null)
public Tenant(String name, TenantArgs args)
public Tenant(String name, TenantArgs args, CustomResourceOptions options)
type: mso:Tenant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TenantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TenantArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TenantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TenantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TenantArgs
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 tenantResource = new Mso.Tenant("tenantResource", new()
{
    DisplayName = "string",
    Description = "string",
    Name = "string",
    OrchestratorOnly = false,
    SiteAssociations = new[]
    {
        new Mso.Inputs.TenantSiteAssociationArgs
        {
            AwsAccessKeyId = "string",
            AwsAccountId = "string",
            AwsSecretKey = "string",
            AzureAccessType = "string",
            AzureActiveDirectoryId = "string",
            AzureApplicationId = "string",
            AzureClientSecret = "string",
            AzureSharedAccountId = "string",
            AzureSubscriptionId = "string",
            GcpAccessType = "string",
            GcpClientId = "string",
            GcpEmail = "string",
            GcpKeyId = "string",
            GcpName = "string",
            GcpPrivateKey = "string",
            GcpProjectId = "string",
            IsAwsAccountTrusted = false,
            SecurityDomains = new[]
            {
                "string",
            },
            SiteId = "string",
            Vendor = "string",
        },
    },
    TenantId = "string",
    UserAssociations = new[]
    {
        new Mso.Inputs.TenantUserAssociationArgs
        {
            UserId = "string",
        },
    },
});
Copy
example, err := mso.NewTenant(ctx, "tenantResource", &mso.TenantArgs{
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
OrchestratorOnly: pulumi.Bool(false),
SiteAssociations: .TenantSiteAssociationArray{
&.TenantSiteAssociationArgs{
AwsAccessKeyId: pulumi.String("string"),
AwsAccountId: pulumi.String("string"),
AwsSecretKey: pulumi.String("string"),
AzureAccessType: pulumi.String("string"),
AzureActiveDirectoryId: pulumi.String("string"),
AzureApplicationId: pulumi.String("string"),
AzureClientSecret: pulumi.String("string"),
AzureSharedAccountId: pulumi.String("string"),
AzureSubscriptionId: pulumi.String("string"),
GcpAccessType: pulumi.String("string"),
GcpClientId: pulumi.String("string"),
GcpEmail: pulumi.String("string"),
GcpKeyId: pulumi.String("string"),
GcpName: pulumi.String("string"),
GcpPrivateKey: pulumi.String("string"),
GcpProjectId: pulumi.String("string"),
IsAwsAccountTrusted: pulumi.Bool(false),
SecurityDomains: pulumi.StringArray{
pulumi.String("string"),
},
SiteId: pulumi.String("string"),
Vendor: pulumi.String("string"),
},
},
TenantId: pulumi.String("string"),
UserAssociations: .TenantUserAssociationArray{
&.TenantUserAssociationArgs{
UserId: pulumi.String("string"),
},
},
})
Copy
var tenantResource = new Tenant("tenantResource", TenantArgs.builder()
    .displayName("string")
    .description("string")
    .name("string")
    .orchestratorOnly(false)
    .siteAssociations(TenantSiteAssociationArgs.builder()
        .awsAccessKeyId("string")
        .awsAccountId("string")
        .awsSecretKey("string")
        .azureAccessType("string")
        .azureActiveDirectoryId("string")
        .azureApplicationId("string")
        .azureClientSecret("string")
        .azureSharedAccountId("string")
        .azureSubscriptionId("string")
        .gcpAccessType("string")
        .gcpClientId("string")
        .gcpEmail("string")
        .gcpKeyId("string")
        .gcpName("string")
        .gcpPrivateKey("string")
        .gcpProjectId("string")
        .isAwsAccountTrusted(false)
        .securityDomains("string")
        .siteId("string")
        .vendor("string")
        .build())
    .tenantId("string")
    .userAssociations(TenantUserAssociationArgs.builder()
        .userId("string")
        .build())
    .build());
Copy
tenant_resource = mso.Tenant("tenantResource",
    display_name="string",
    description="string",
    name="string",
    orchestrator_only=False,
    site_associations=[{
        "aws_access_key_id": "string",
        "aws_account_id": "string",
        "aws_secret_key": "string",
        "azure_access_type": "string",
        "azure_active_directory_id": "string",
        "azure_application_id": "string",
        "azure_client_secret": "string",
        "azure_shared_account_id": "string",
        "azure_subscription_id": "string",
        "gcp_access_type": "string",
        "gcp_client_id": "string",
        "gcp_email": "string",
        "gcp_key_id": "string",
        "gcp_name": "string",
        "gcp_private_key": "string",
        "gcp_project_id": "string",
        "is_aws_account_trusted": False,
        "security_domains": ["string"],
        "site_id": "string",
        "vendor": "string",
    }],
    tenant_id="string",
    user_associations=[{
        "user_id": "string",
    }])
Copy
const tenantResource = new mso.Tenant("tenantResource", {
    displayName: "string",
    description: "string",
    name: "string",
    orchestratorOnly: false,
    siteAssociations: [{
        awsAccessKeyId: "string",
        awsAccountId: "string",
        awsSecretKey: "string",
        azureAccessType: "string",
        azureActiveDirectoryId: "string",
        azureApplicationId: "string",
        azureClientSecret: "string",
        azureSharedAccountId: "string",
        azureSubscriptionId: "string",
        gcpAccessType: "string",
        gcpClientId: "string",
        gcpEmail: "string",
        gcpKeyId: "string",
        gcpName: "string",
        gcpPrivateKey: "string",
        gcpProjectId: "string",
        isAwsAccountTrusted: false,
        securityDomains: ["string"],
        siteId: "string",
        vendor: "string",
    }],
    tenantId: "string",
    userAssociations: [{
        userId: "string",
    }],
});
Copy
type: mso:Tenant
properties:
    description: string
    displayName: string
    name: string
    orchestratorOnly: false
    siteAssociations:
        - awsAccessKeyId: string
          awsAccountId: string
          awsSecretKey: string
          azureAccessType: string
          azureActiveDirectoryId: string
          azureApplicationId: string
          azureClientSecret: string
          azureSharedAccountId: string
          azureSubscriptionId: string
          gcpAccessType: string
          gcpClientId: string
          gcpEmail: string
          gcpKeyId: string
          gcpName: string
          gcpPrivateKey: string
          gcpProjectId: string
          isAwsAccountTrusted: false
          securityDomains:
            - string
          siteId: string
          vendor: string
    tenantId: string
    userAssociations:
        - userId: string
Copy

Tenant 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 Tenant resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the Tenant 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 Tenant Resource

Get an existing Tenant 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?: TenantState, opts?: CustomResourceOptions): Tenant
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        orchestrator_only: Optional[bool] = None,
        site_associations: Optional[Sequence[TenantSiteAssociationArgs]] = None,
        tenant_id: Optional[str] = None,
        user_associations: Optional[Sequence[TenantUserAssociationArgs]] = None) -> Tenant
func GetTenant(ctx *Context, name string, id IDInput, state *TenantState, opts ...ResourceOption) (*Tenant, error)
public static Tenant Get(string name, Input<string> id, TenantState? state, CustomResourceOptions? opts = null)
public static Tenant get(String name, Output<String> id, TenantState state, CustomResourceOptions options)
resources:  _:    type: mso:Tenant    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Supporting Types

TenantSiteAssociation
, TenantSiteAssociationArgs

TenantUserAssociation
, TenantUserAssociationArgs

UserId string
UserId string
userId String
userId string
userId String

Package Details

Repository
mso ciscodevnet/terraform-provider-mso
License
Notes
This Pulumi package is based on the mso Terraform Provider.