Data types

Azure.ClientGenerator.Core

ClientInitializationOptions

Client initialization customization options.

In addition to the properties below, this inherits scope from DecoratorOptions, so options.scope can select which language emitters the @clientInitialization customization applies to.

model Azure.ClientGenerator.Core.ClientInitializationOptions

Properties

Name	Type	Description
parameters?	Model	Redefine the client initialization parameters you would like to add to the client. All the model properties should have corresponding operation level parameters. By default, we apply endpoint, credential, and API version parameters. If you specify a parameters model, we will append the properties of the model to the parameters list of the client initialization.
initializedBy?	EnumMember | Union	Determines how the client can be initialized. Use InitializedBy enum to set the value. The value can be InitializedBy.individually, InitializedBy.parent or InitializedBy.individually | InitializedBy.parent.

ClientOptions

Client customization options.

In addition to the properties below, this inherits scope from DecoratorOptions, so options.scope can select which language emitters the @client customization applies to.

model Azure.ClientGenerator.Core.ClientOptions

Properties

Name	Type	Description
service?	Namespace | Namespace[]	The services that this client is generated for. The root explicit client must have service config. The namespace should be decorated with @service.
name?	string	The name of the client. If not specified, the default name will be <Name of the target>Client.
autoMergeService?	boolean	Auto-merge service’s things into current client.

DecoratorOptions

Common typed options bag for the scope argument accepted by scoped TCGC decorators.

Every scoped decorator’s own options model can extend this base so new, decorator-specific settings can be added over time without breaking the legacy plain-string scope argument.

Supported language identifiers: csharp, python, java, javascript, go, and other language emitter names (derived from the emitter package name, e.g., @azure-tools/typespec-csharp → csharp).

Valid patterns for scope:

• Single language: "python"
• Multiple languages (comma-separated): "python, java"
• Negation to exclude languages: "!csharp" or "!(java, python)"

model Azure.ClientGenerator.Core.DecoratorOptions

Properties

Name	Type	Description
scope?	string	Specifies the target language emitters that a decorator should apply to. If not set, the decorator applies to all language emitters by default.

ExternalType

Represents an external type that can be used in alternate type definitions.

model Azure.ClientGenerator.Core.ExternalType

Properties

Name	Type	Description
identity	string	The identity of the external type. For example, pystac.Collection
package?	string	The package that exports the external type. For example, pystac
minVersion?	string	The minimum version of the package to use for your external type. For example, 1.13.0

Access

Access value.

enum Azure.ClientGenerator.Core.Access

Name	Value	Description
public	"public"	Open to user
internal	"internal"	Hide from user

DocumentationMode

Defines how client documentation should be applied

enum Azure.ClientGenerator.Core.DocumentationMode

Name	Value	Description
append	"append"	Append client documentation to the existing doc
replace	"replace"	Replace the existing doc with client documentation

InitializedBy

InitializedBy value.

enum Azure.ClientGenerator.Core.InitializedBy

Name	Value	Description
individually	1	The client could be initialized individually.
parent	2	The client could be initialized by parent client.
customizeCode	4	The client initialization should be omitted from generated code and handled manually in custom code.

Usage

Usage value.

enum Azure.ClientGenerator.Core.Usage

Name	Value	Description
input	2	Used in request
output	4	Used in response
json	256	Used with JSON content type
xml	512	Used with XML content type