Docs Packages
  1. Packages
  2. vSphere
  3. API Docs
  4. ContentLibrary
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.ContentLibrary

Explore with Pulumi AI

vsphere logo
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

    Create ContentLibrary Resource

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

    Constructor syntax

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

@overload
def ContentLibrary(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   storage_backings: Optional[Sequence[str]] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   publication: Optional[ContentLibraryPublicationArgs] = None,
                   subscription: Optional[ContentLibrarySubscriptionArgs] = None)
    func NewContentLibrary(ctx *Context, name string, args ContentLibraryArgs, opts ...ResourceOption) (*ContentLibrary, error)
    public ContentLibrary(string name, ContentLibraryArgs args, CustomResourceOptions? opts = null)
    public ContentLibrary(String name, ContentLibraryArgs args)
public ContentLibrary(String name, ContentLibraryArgs args, CustomResourceOptions options)

    type: vsphere:ContentLibrary
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 ContentLibraryArgs
    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 ContentLibraryArgs
    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 ContentLibraryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContentLibraryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContentLibraryArgs
    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 contentLibraryResource = new VSphere.ContentLibrary("contentLibraryResource", new()
{
    StorageBackings = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    Publication = new VSphere.Inputs.ContentLibraryPublicationArgs
    {
        AuthenticationMethod = "string",
        Password = "string",
        PublishUrl = "string",
        Published = false,
        Username = "string",
    },
    Subscription = new VSphere.Inputs.ContentLibrarySubscriptionArgs
    {
        AuthenticationMethod = "string",
        AutomaticSync = false,
        OnDemand = false,
        Password = "string",
        SubscriptionUrl = "string",
        Username = "string",
    },
});

    example, err := vsphere.NewContentLibrary(ctx, "contentLibraryResource", &vsphere.ContentLibraryArgs{
	StorageBackings: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Publication: &vsphere.ContentLibraryPublicationArgs{
		AuthenticationMethod: pulumi.String("string"),
		Password:             pulumi.String("string"),
		PublishUrl:           pulumi.String("string"),
		Published:            pulumi.Bool(false),
		Username:             pulumi.String("string"),
	},
	Subscription: &vsphere.ContentLibrarySubscriptionArgs{
		AuthenticationMethod: pulumi.String("string"),
		AutomaticSync:        pulumi.Bool(false),
		OnDemand:             pulumi.Bool(false),
		Password:             pulumi.String("string"),
		SubscriptionUrl:      pulumi.String("string"),
		Username:             pulumi.String("string"),
	},
})

    var contentLibraryResource = new ContentLibrary("contentLibraryResource", ContentLibraryArgs.builder()
    .storageBackings("string")
    .description("string")
    .name("string")
    .publication(ContentLibraryPublicationArgs.builder()
        .authenticationMethod("string")
        .password("string")
        .publishUrl("string")
        .published(false)
        .username("string")
        .build())
    .subscription(ContentLibrarySubscriptionArgs.builder()
        .authenticationMethod("string")
        .automaticSync(false)
        .onDemand(false)
        .password("string")
        .subscriptionUrl("string")
        .username("string")
        .build())
    .build());

    content_library_resource = vsphere.ContentLibrary("contentLibraryResource",
    storage_backings=["string"],
    description="string",
    name="string",
    publication=vsphere.ContentLibraryPublicationArgs(
        authentication_method="string",
        password="string",
        publish_url="string",
        published=False,
        username="string",
    ),
    subscription=vsphere.ContentLibrarySubscriptionArgs(
        authentication_method="string",
        automatic_sync=False,
        on_demand=False,
        password="string",
        subscription_url="string",
        username="string",
    ))

    const contentLibraryResource = new vsphere.ContentLibrary("contentLibraryResource", {
    storageBackings: ["string"],
    description: "string",
    name: "string",
    publication: {
        authenticationMethod: "string",
        password: "string",
        publishUrl: "string",
        published: false,
        username: "string",
    },
    subscription: {
        authenticationMethod: "string",
        automaticSync: false,
        onDemand: false,
        password: "string",
        subscriptionUrl: "string",
        username: "string",
    },
});

    type: vsphere:ContentLibrary
properties:
    description: string
    name: string
    publication:
        authenticationMethod: string
        password: string
        publishUrl: string
        published: false
        username: string
    storageBackings:
        - string
    subscription:
        authenticationMethod: string
        automaticSync: false
        onDemand: false
        password: string
        subscriptionUrl: string
        username: string

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

    StorageBackings List<string>
    The managed object reference ID of the datastore on which to store the content library items.
    Description string
    A description for the content library.
    Name string
    The name of the content library.
    Publication Pulumi.VSphere.Inputs.ContentLibraryPublication
    Options to publish a local content library.
    Subscription Pulumi.VSphere.Inputs.ContentLibrarySubscription
    Options subscribe to a published content library.
    StorageBackings []string
    The managed object reference ID of the datastore on which to store the content library items.
    Description string
    A description for the content library.
    Name string
    The name of the content library.
    Publication ContentLibraryPublicationArgs
    Options to publish a local content library.
    Subscription ContentLibrarySubscriptionArgs
    Options subscribe to a published content library.
    storageBackings List<String>
    The managed object reference ID of the datastore on which to store the content library items.
    description String
    A description for the content library.
    name String
    The name of the content library.
    publication ContentLibraryPublication
    Options to publish a local content library.
    subscription ContentLibrarySubscription
    Options subscribe to a published content library.
    storageBackings string[]
    The managed object reference ID of the datastore on which to store the content library items.
    description string
    A description for the content library.
    name string
    The name of the content library.
    publication ContentLibraryPublication
    Options to publish a local content library.
    subscription ContentLibrarySubscription
    Options subscribe to a published content library.
    storage_backings Sequence[str]
    The managed object reference ID of the datastore on which to store the content library items.
    description str
    A description for the content library.
    name str
    The name of the content library.
    publication ContentLibraryPublicationArgs
    Options to publish a local content library.
    subscription ContentLibrarySubscriptionArgs
    Options subscribe to a published content library.
    storageBackings List<String>
    The managed object reference ID of the datastore on which to store the content library items.
    description String
    A description for the content library.
    name String
    The name of the content library.
    publication Property Map
    Options to publish a local content library.
    subscription Property Map
    Options subscribe to a published content library.

    Outputs

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

    Get an existing ContentLibrary 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?: ContentLibraryState, opts?: CustomResourceOptions): ContentLibrary
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        publication: Optional[ContentLibraryPublicationArgs] = None,
        storage_backings: Optional[Sequence[str]] = None,
        subscription: Optional[ContentLibrarySubscriptionArgs] = None) -> ContentLibrary
    func GetContentLibrary(ctx *Context, name string, id IDInput, state *ContentLibraryState, opts ...ResourceOption) (*ContentLibrary, error)
    public static ContentLibrary Get(string name, Input<string> id, ContentLibraryState? state, CustomResourceOptions? opts = null)
    public static ContentLibrary get(String name, Output<String> id, ContentLibraryState 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:
    Description string
    A description for the content library.
    Name string
    The name of the content library.
    Publication Pulumi.VSphere.Inputs.ContentLibraryPublication
    Options to publish a local content library.
    StorageBackings List<string>
    The managed object reference ID of the datastore on which to store the content library items.
    Subscription Pulumi.VSphere.Inputs.ContentLibrarySubscription
    Options subscribe to a published content library.
    Description string
    A description for the content library.
    Name string
    The name of the content library.
    Publication ContentLibraryPublicationArgs
    Options to publish a local content library.
    StorageBackings []string
    The managed object reference ID of the datastore on which to store the content library items.
    Subscription ContentLibrarySubscriptionArgs
    Options subscribe to a published content library.
    description String
    A description for the content library.
    name String
    The name of the content library.
    publication ContentLibraryPublication
    Options to publish a local content library.
    storageBackings List<String>
    The managed object reference ID of the datastore on which to store the content library items.
    subscription ContentLibrarySubscription
    Options subscribe to a published content library.
    description string
    A description for the content library.
    name string
    The name of the content library.
    publication ContentLibraryPublication
    Options to publish a local content library.
    storageBackings string[]
    The managed object reference ID of the datastore on which to store the content library items.
    subscription ContentLibrarySubscription
    Options subscribe to a published content library.
    description str
    A description for the content library.
    name str
    The name of the content library.
    publication ContentLibraryPublicationArgs
    Options to publish a local content library.
    storage_backings Sequence[str]
    The managed object reference ID of the datastore on which to store the content library items.
    subscription ContentLibrarySubscriptionArgs
    Options subscribe to a published content library.
    description String
    A description for the content library.
    name String
    The name of the content library.
    publication Property Map
    Options to publish a local content library.
    storageBackings List<String>
    The managed object reference ID of the datastore on which to store the content library items.
    subscription Property Map
    Options subscribe to a published content library.

    Supporting Types

    ContentLibraryPublication, ContentLibraryPublicationArgs

    AuthenticationMethod string
    Method to authenticate users. Must be NONE or BASIC.
    Password string
    Password used by subscribers to authenticate.
    PublishUrl string
    The URL of the published content library.
    Published bool
    Publish the content library. Default false.
    Username string
    Username used by subscribers to authenticate. Currently can only be vcsp.
    AuthenticationMethod string
    Method to authenticate users. Must be NONE or BASIC.
    Password string
    Password used by subscribers to authenticate.
    PublishUrl string
    The URL of the published content library.
    Published bool
    Publish the content library. Default false.
    Username string
    Username used by subscribers to authenticate. Currently can only be vcsp.
    authenticationMethod String
    Method to authenticate users. Must be NONE or BASIC.
    password String
    Password used by subscribers to authenticate.
    publishUrl String
    The URL of the published content library.
    published Boolean
    Publish the content library. Default false.
    username String
    Username used by subscribers to authenticate. Currently can only be vcsp.
    authenticationMethod string
    Method to authenticate users. Must be NONE or BASIC.
    password string
    Password used by subscribers to authenticate.
    publishUrl string
    The URL of the published content library.
    published boolean
    Publish the content library. Default false.
    username string
    Username used by subscribers to authenticate. Currently can only be vcsp.
    authentication_method str
    Method to authenticate users. Must be NONE or BASIC.
    password str
    Password used by subscribers to authenticate.
    publish_url str
    The URL of the published content library.
    published bool
    Publish the content library. Default false.
    username str
    Username used by subscribers to authenticate. Currently can only be vcsp.
    authenticationMethod String
    Method to authenticate users. Must be NONE or BASIC.
    password String
    Password used by subscribers to authenticate.
    publishUrl String
    The URL of the published content library.
    published Boolean
    Publish the content library. Default false.
    username String
    Username used by subscribers to authenticate. Currently can only be vcsp.

    ContentLibrarySubscription, ContentLibrarySubscriptionArgs

    AuthenticationMethod string
    Authentication method to connect ro a published content library. Must be NONE or BASIC.
    AutomaticSync bool
    Enable automatic synchronization with the published library. Default false.
    OnDemand bool
    Download the library from a content only when needed. Default true.
    Password string
    Password used for authentication.
    SubscriptionUrl string
    URL of the published content library.
    Username string
    Username used for authentication.
    AuthenticationMethod string
    Authentication method to connect ro a published content library. Must be NONE or BASIC.
    AutomaticSync bool
    Enable automatic synchronization with the published library. Default false.
    OnDemand bool
    Download the library from a content only when needed. Default true.
    Password string
    Password used for authentication.
    SubscriptionUrl string
    URL of the published content library.
    Username string
    Username used for authentication.
    authenticationMethod String
    Authentication method to connect ro a published content library. Must be NONE or BASIC.
    automaticSync Boolean
    Enable automatic synchronization with the published library. Default false.
    onDemand Boolean
    Download the library from a content only when needed. Default true.
    password String
    Password used for authentication.
    subscriptionUrl String
    URL of the published content library.
    username String
    Username used for authentication.
    authenticationMethod string
    Authentication method to connect ro a published content library. Must be NONE or BASIC.
    automaticSync boolean
    Enable automatic synchronization with the published library. Default false.
    onDemand boolean
    Download the library from a content only when needed. Default true.
    password string
    Password used for authentication.
    subscriptionUrl string
    URL of the published content library.
    username string
    Username used for authentication.
    authentication_method str
    Authentication method to connect ro a published content library. Must be NONE or BASIC.
    automatic_sync bool
    Enable automatic synchronization with the published library. Default false.
    on_demand bool
    Download the library from a content only when needed. Default true.
    password str
    Password used for authentication.
    subscription_url str
    URL of the published content library.
    username str
    Username used for authentication.
    authenticationMethod String
    Authentication method to connect ro a published content library. Must be NONE or BASIC.
    automaticSync Boolean
    Enable automatic synchronization with the published library. Default false.
    onDemand Boolean
    Download the library from a content only when needed. Default true.
    password String
    Password used for authentication.
    subscriptionUrl String
    URL of the published content library.
    username String
    Username used for authentication.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-vsphere