pulumi-azure-native 2.33.1a1711540390__py3-none-any.whl → 2.34.1a1712062553__py3-none-any.whl

pulumi_azure_native/apicenter/v20240315preview/environment.py

@@ -0,0 +1,384 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+from ._enums import *
+from ._inputs import *
+
+__all__ = ['EnvironmentArgs', 'Environment']
+
+@pulumi.input_type
+class EnvironmentArgs:
+    def __init__(__self__, *,
+                 kind: pulumi.Input[Union[str, 'EnvironmentKind']],
+                 resource_group_name: pulumi.Input[str],
+                 service_name: pulumi.Input[str],
+                 title: pulumi.Input[str],
+                 workspace_name: pulumi.Input[str],
+                 custom_properties: Optional[Any] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 environment_name: Optional[pulumi.Input[str]] = None,
+                 onboarding: Optional[pulumi.Input['OnboardingArgs']] = None,
+                 server: Optional[pulumi.Input['EnvironmentServerArgs']] = None):
+        """
+        The set of arguments for constructing a Environment resource.
+        :param pulumi.Input[Union[str, 'EnvironmentKind']] kind: Environment kind.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[str] service_name: The name of Azure API Center service.
+        :param pulumi.Input[str] title: Environment title.
+        :param pulumi.Input[str] workspace_name: The name of the workspace.
+        :param Any custom_properties: The custom metadata defined for API catalog entities.
+        :param pulumi.Input[str] description: The environment description.
+        :param pulumi.Input[str] environment_name: The name of the environment.
+        :param pulumi.Input['OnboardingArgs'] onboarding: Environment onboarding information
+        :param pulumi.Input['EnvironmentServerArgs'] server: Server information of the environment.
+        """
+        pulumi.set(__self__, "kind", kind)
+        pulumi.set(__self__, "resource_group_name", resource_group_name)
+        pulumi.set(__self__, "service_name", service_name)
+        pulumi.set(__self__, "title", title)
+        pulumi.set(__self__, "workspace_name", workspace_name)
+        if custom_properties is not None:
+            pulumi.set(__self__, "custom_properties", custom_properties)
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if environment_name is not None:
+            pulumi.set(__self__, "environment_name", environment_name)
+        if onboarding is not None:
+            pulumi.set(__self__, "onboarding", onboarding)
+        if server is not None:
+            pulumi.set(__self__, "server", server)
+
+    @property
+    @pulumi.getter
+    def kind(self) -> pulumi.Input[Union[str, 'EnvironmentKind']]:
+        """
+        Environment kind.
+        """
+        return pulumi.get(self, "kind")
+
+    @kind.setter
+    def kind(self, value: pulumi.Input[Union[str, 'EnvironmentKind']]):
+        pulumi.set(self, "kind", value)
+
+    @property
+    @pulumi.getter(name="resourceGroupName")
+    def resource_group_name(self) -> pulumi.Input[str]:
+        """
+        The name of the resource group. The name is case insensitive.
+        """
+        return pulumi.get(self, "resource_group_name")
+
+    @resource_group_name.setter
+    def resource_group_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "resource_group_name", value)
+
+    @property
+    @pulumi.getter(name="serviceName")
+    def service_name(self) -> pulumi.Input[str]:
+        """
+        The name of Azure API Center service.
+        """
+        return pulumi.get(self, "service_name")
+
+    @service_name.setter
+    def service_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "service_name", value)
+
+    @property
+    @pulumi.getter
+    def title(self) -> pulumi.Input[str]:
+        """
+        Environment title.
+        """
+        return pulumi.get(self, "title")
+
+    @title.setter
+    def title(self, value: pulumi.Input[str]):
+        pulumi.set(self, "title", value)
+
+    @property
+    @pulumi.getter(name="workspaceName")
+    def workspace_name(self) -> pulumi.Input[str]:
+        """
+        The name of the workspace.
+        """
+        return pulumi.get(self, "workspace_name")
+
+    @workspace_name.setter
+    def workspace_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "workspace_name", value)
+
+    @property
+    @pulumi.getter(name="customProperties")
+    def custom_properties(self) -> Optional[Any]:
+        """
+        The custom metadata defined for API catalog entities.
+        """
+        return pulumi.get(self, "custom_properties")
+
+    @custom_properties.setter
+    def custom_properties(self, value: Optional[Any]):
+        pulumi.set(self, "custom_properties", value)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[str]]:
+        """
+        The environment description.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="environmentName")
+    def environment_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The name of the environment.
+        """
+        return pulumi.get(self, "environment_name")
+
+    @environment_name.setter
+    def environment_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "environment_name", value)
+
+    @property
+    @pulumi.getter
+    def onboarding(self) -> Optional[pulumi.Input['OnboardingArgs']]:
+        """
+        Environment onboarding information
+        """
+        return pulumi.get(self, "onboarding")
+
+    @onboarding.setter
+    def onboarding(self, value: Optional[pulumi.Input['OnboardingArgs']]):
+        pulumi.set(self, "onboarding", value)
+
+    @property
+    @pulumi.getter
+    def server(self) -> Optional[pulumi.Input['EnvironmentServerArgs']]:
+        """
+        Server information of the environment.
+        """
+        return pulumi.get(self, "server")
+
+    @server.setter
+    def server(self, value: Optional[pulumi.Input['EnvironmentServerArgs']]):
+        pulumi.set(self, "server", value)
+
+
+class Environment(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 custom_properties: Optional[Any] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 environment_name: Optional[pulumi.Input[str]] = None,
+                 kind: Optional[pulumi.Input[Union[str, 'EnvironmentKind']]] = None,
+                 onboarding: Optional[pulumi.Input[pulumi.InputType['OnboardingArgs']]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 server: Optional[pulumi.Input[pulumi.InputType['EnvironmentServerArgs']]] = None,
+                 service_name: Optional[pulumi.Input[str]] = None,
+                 title: Optional[pulumi.Input[str]] = None,
+                 workspace_name: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        Environment entity.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param Any custom_properties: The custom metadata defined for API catalog entities.
+        :param pulumi.Input[str] description: The environment description.
+        :param pulumi.Input[str] environment_name: The name of the environment.
+        :param pulumi.Input[Union[str, 'EnvironmentKind']] kind: Environment kind.
+        :param pulumi.Input[pulumi.InputType['OnboardingArgs']] onboarding: Environment onboarding information
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[pulumi.InputType['EnvironmentServerArgs']] server: Server information of the environment.
+        :param pulumi.Input[str] service_name: The name of Azure API Center service.
+        :param pulumi.Input[str] title: Environment title.
+        :param pulumi.Input[str] workspace_name: The name of the workspace.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: EnvironmentArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Environment entity.
+
+        :param str resource_name: The name of the resource.
+        :param EnvironmentArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(EnvironmentArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 custom_properties: Optional[Any] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 environment_name: Optional[pulumi.Input[str]] = None,
+                 kind: Optional[pulumi.Input[Union[str, 'EnvironmentKind']]] = None,
+                 onboarding: Optional[pulumi.Input[pulumi.InputType['OnboardingArgs']]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 server: Optional[pulumi.Input[pulumi.InputType['EnvironmentServerArgs']]] = None,
+                 service_name: Optional[pulumi.Input[str]] = None,
+                 title: Optional[pulumi.Input[str]] = None,
+                 workspace_name: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = EnvironmentArgs.__new__(EnvironmentArgs)
+
+            __props__.__dict__["custom_properties"] = custom_properties
+            __props__.__dict__["description"] = description
+            __props__.__dict__["environment_name"] = environment_name
+            if kind is None and not opts.urn:
+                raise TypeError("Missing required property 'kind'")
+            __props__.__dict__["kind"] = kind
+            __props__.__dict__["onboarding"] = onboarding
+            if resource_group_name is None and not opts.urn:
+                raise TypeError("Missing required property 'resource_group_name'")
+            __props__.__dict__["resource_group_name"] = resource_group_name
+            __props__.__dict__["server"] = server
+            if service_name is None and not opts.urn:
+                raise TypeError("Missing required property 'service_name'")
+            __props__.__dict__["service_name"] = service_name
+            if title is None and not opts.urn:
+                raise TypeError("Missing required property 'title'")
+            __props__.__dict__["title"] = title
+            if workspace_name is None and not opts.urn:
+                raise TypeError("Missing required property 'workspace_name'")
+            __props__.__dict__["workspace_name"] = workspace_name
+            __props__.__dict__["name"] = None
+            __props__.__dict__["system_data"] = None
+            __props__.__dict__["type"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="azure-native:apicenter:Environment"), pulumi.Alias(type_="azure-native:apicenter/v20240301:Environment")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(Environment, __self__).__init__(
+            'azure-native:apicenter/v20240315preview:Environment',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None) -> 'Environment':
+        """
+        Get an existing Environment resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = EnvironmentArgs.__new__(EnvironmentArgs)
+
+        __props__.__dict__["custom_properties"] = None
+        __props__.__dict__["description"] = None
+        __props__.__dict__["kind"] = None
+        __props__.__dict__["name"] = None
+        __props__.__dict__["onboarding"] = None
+        __props__.__dict__["server"] = None
+        __props__.__dict__["system_data"] = None
+        __props__.__dict__["title"] = None
+        __props__.__dict__["type"] = None
+        return Environment(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="customProperties")
+    def custom_properties(self) -> pulumi.Output[Optional[Any]]:
+        """
+        The custom metadata defined for API catalog entities.
+        """
+        return pulumi.get(self, "custom_properties")
+
+    @property
+    @pulumi.getter
+    def description(self) -> pulumi.Output[Optional[str]]:
+        """
+        The environment description.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter
+    def kind(self) -> pulumi.Output[str]:
+        """
+        Environment kind.
+        """
+        return pulumi.get(self, "kind")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def onboarding(self) -> pulumi.Output[Optional['outputs.OnboardingResponse']]:
+        """
+        Environment onboarding information
+        """
+        return pulumi.get(self, "onboarding")
+
+    @property
+    @pulumi.getter
+    def server(self) -> pulumi.Output[Optional['outputs.EnvironmentServerResponse']]:
+        """
+        Server information of the environment.
+        """
+        return pulumi.get(self, "server")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> pulumi.Output['outputs.SystemDataResponse']:
+        """
+        Azure Resource Manager metadata containing createdBy and modifiedBy information.
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter
+    def title(self) -> pulumi.Output[str]:
+        """
+        Environment title.
+        """
+        return pulumi.get(self, "title")
+
+    @property
+    @pulumi.getter
+    def type(self) -> pulumi.Output[str]:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+

pulumi_azure_native/apicenter/v20240315preview/get_api.py

@@ -0,0 +1,258 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetApiResult',
+    'AwaitableGetApiResult',
+    'get_api',
+    'get_api_output',
+]
+
+@pulumi.output_type
+class GetApiResult:
+    """
+    API entity.
+    """
+    def __init__(__self__, contacts=None, custom_properties=None, description=None, external_documentation=None, id=None, kind=None, license=None, lifecycle_stage=None, name=None, summary=None, system_data=None, terms_of_service=None, title=None, type=None):
+        if contacts and not isinstance(contacts, list):
+            raise TypeError("Expected argument 'contacts' to be a list")
+        pulumi.set(__self__, "contacts", contacts)
+        if custom_properties and not isinstance(custom_properties, dict):
+            raise TypeError("Expected argument 'custom_properties' to be a dict")
+        pulumi.set(__self__, "custom_properties", custom_properties)
+        if description and not isinstance(description, str):
+            raise TypeError("Expected argument 'description' to be a str")
+        pulumi.set(__self__, "description", description)
+        if external_documentation and not isinstance(external_documentation, list):
+            raise TypeError("Expected argument 'external_documentation' to be a list")
+        pulumi.set(__self__, "external_documentation", external_documentation)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if kind and not isinstance(kind, str):
+            raise TypeError("Expected argument 'kind' to be a str")
+        pulumi.set(__self__, "kind", kind)
+        if license and not isinstance(license, dict):
+            raise TypeError("Expected argument 'license' to be a dict")
+        pulumi.set(__self__, "license", license)
+        if lifecycle_stage and not isinstance(lifecycle_stage, str):
+            raise TypeError("Expected argument 'lifecycle_stage' to be a str")
+        pulumi.set(__self__, "lifecycle_stage", lifecycle_stage)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if summary and not isinstance(summary, str):
+            raise TypeError("Expected argument 'summary' to be a str")
+        pulumi.set(__self__, "summary", summary)
+        if system_data and not isinstance(system_data, dict):
+            raise TypeError("Expected argument 'system_data' to be a dict")
+        pulumi.set(__self__, "system_data", system_data)
+        if terms_of_service and not isinstance(terms_of_service, dict):
+            raise TypeError("Expected argument 'terms_of_service' to be a dict")
+        pulumi.set(__self__, "terms_of_service", terms_of_service)
+        if title and not isinstance(title, str):
+            raise TypeError("Expected argument 'title' to be a str")
+        pulumi.set(__self__, "title", title)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter
+    def contacts(self) -> Optional[Sequence['outputs.ContactResponse']]:
+        """
+        The set of contacts
+        """
+        return pulumi.get(self, "contacts")
+
+    @property
+    @pulumi.getter(name="customProperties")
+    def custom_properties(self) -> Optional[Any]:
+        """
+        The custom metadata defined for API catalog entities.
+        """
+        return pulumi.get(self, "custom_properties")
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[str]:
+        """
+        Description of the API.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter(name="externalDocumentation")
+    def external_documentation(self) -> Optional[Sequence['outputs.ExternalDocumentationResponse']]:
+        """
+        The set of external documentation
+        """
+        return pulumi.get(self, "external_documentation")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def kind(self) -> str:
+        """
+        Kind of API. For example, REST or GraphQL.
+        """
+        return pulumi.get(self, "kind")
+
+    @property
+    @pulumi.getter
+    def license(self) -> Optional['outputs.LicenseResponse']:
+        """
+        The license information for the API.
+        """
+        return pulumi.get(self, "license")
+
+    @property
+    @pulumi.getter(name="lifecycleStage")
+    def lifecycle_stage(self) -> str:
+        """
+        Current lifecycle stage of the API.
+        """
+        return pulumi.get(self, "lifecycle_stage")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def summary(self) -> Optional[str]:
+        """
+        Short description of the API.
+        """
+        return pulumi.get(self, "summary")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> 'outputs.SystemDataResponse':
+        """
+        Azure Resource Manager metadata containing createdBy and modifiedBy information.
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter(name="termsOfService")
+    def terms_of_service(self) -> Optional['outputs.TermsOfServiceResponse']:
+        """
+        Terms of service for the API.
+        """
+        return pulumi.get(self, "terms_of_service")
+
+    @property
+    @pulumi.getter
+    def title(self) -> str:
+        """
+        API title.
+        """
+        return pulumi.get(self, "title")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetApiResult(GetApiResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetApiResult(
+            contacts=self.contacts,
+            custom_properties=self.custom_properties,
+            description=self.description,
+            external_documentation=self.external_documentation,
+            id=self.id,
+            kind=self.kind,
+            license=self.license,
+            lifecycle_stage=self.lifecycle_stage,
+            name=self.name,
+            summary=self.summary,
+            system_data=self.system_data,
+            terms_of_service=self.terms_of_service,
+            title=self.title,
+            type=self.type)
+
+
+def get_api(api_name: Optional[str] = None,
+            resource_group_name: Optional[str] = None,
+            service_name: Optional[str] = None,
+            workspace_name: Optional[str] = None,
+            opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetApiResult:
+    """
+    Returns details of the API.
+
+
+    :param str api_name: The name of the API.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str service_name: The name of Azure API Center service.
+    :param str workspace_name: The name of the workspace.
+    """
+    __args__ = dict()
+    __args__['apiName'] = api_name
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['serviceName'] = service_name
+    __args__['workspaceName'] = workspace_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:apicenter/v20240315preview:getApi', __args__, opts=opts, typ=GetApiResult).value
+
+    return AwaitableGetApiResult(
+        contacts=pulumi.get(__ret__, 'contacts'),
+        custom_properties=pulumi.get(__ret__, 'custom_properties'),
+        description=pulumi.get(__ret__, 'description'),
+        external_documentation=pulumi.get(__ret__, 'external_documentation'),
+        id=pulumi.get(__ret__, 'id'),
+        kind=pulumi.get(__ret__, 'kind'),
+        license=pulumi.get(__ret__, 'license'),
+        lifecycle_stage=pulumi.get(__ret__, 'lifecycle_stage'),
+        name=pulumi.get(__ret__, 'name'),
+        summary=pulumi.get(__ret__, 'summary'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        terms_of_service=pulumi.get(__ret__, 'terms_of_service'),
+        title=pulumi.get(__ret__, 'title'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_api)
+def get_api_output(api_name: Optional[pulumi.Input[str]] = None,
+                   resource_group_name: Optional[pulumi.Input[str]] = None,
+                   service_name: Optional[pulumi.Input[str]] = None,
+                   workspace_name: Optional[pulumi.Input[str]] = None,
+                   opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetApiResult]:
+    """
+    Returns details of the API.
+
+
+    :param str api_name: The name of the API.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str service_name: The name of Azure API Center service.
+    :param str workspace_name: The name of the workspace.
+    """
+    ...