Data types
Azure.ClientGenerator.Core
Section titled “Azure.ClientGenerator.Core”ClientInitializationOptions
Section titled “ClientInitializationOptions”Client initialization customization options.
model Azure.ClientGenerator.Core.ClientInitializationOptionsProperties
Section titled “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
Section titled “ClientOptions”Client customization options.
model Azure.ClientGenerator.Core.ClientOptionsProperties
Section titled “Properties”| Name | Type | Description |
|---|---|---|
| service? | Namespace | The service that this client is generated for. If not specified, TCGC will look up the first parent namespace decorated with @service for the target.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. |
ExternalType
Section titled “ExternalType”Represents an external type that can be used in alternate type definitions.
model Azure.ClientGenerator.Core.ExternalTypeProperties
Section titled “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 value.
enum Azure.ClientGenerator.Core.Access| Name | Value | Description |
|---|---|---|
| public | "public" | Open to user |
| internal | "internal" | Hide from user |
DocumentationMode
Section titled “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
Section titled “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. |
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 |