[I] SdkContext

Extends

TCGCContext

Type Parameters

Type Parameter	Default type
`TOptions` extends `object`	`Record`<`string`, `any`>
`TServiceOperation` extends `SdkServiceOperation`	`SdkHttpOperation`

Properties

Property	Type	Inherited from
`__arrayDictionaryCache`	`Map`<`Type`, \| `SdkArrayType` \| `SdkDictionaryType`>	`TCGCContext`.`__arrayDictionaryCache`
`__clientApiVersionDefaultValueCache`	`Map`<`SdkClient` \| `SdkOperationGroup`, `string` \| `undefined`>	`TCGCContext`.`__clientApiVersionDefaultValueCache`
`__clientParametersCache`	`Map`<`SdkClient` \| `SdkOperationGroup`, `SdkMethodParameter`[]>	`TCGCContext`.`__clientParametersCache`
`__clientToOperationsCache?`	`Map`<`SdkClient` \| `SdkOperationGroup`, `Operation`[]>	`TCGCContext`.`__clientToOperationsCache`
`__externalPackageToVersions?`	`Map`<`string`, `string`>	`TCGCContext`.`__externalPackageToVersions`
`__generatedNames`	`Map`<`Type`, `string`>	`TCGCContext`.`__generatedNames`
`__httpOperationCache`	`Map`<`Operation`, `HttpOperation`>	`TCGCContext`.`__httpOperationCache`
`__httpOperationExamples`	`Map`<`HttpOperation`, `SdkHttpOperationExample`[]>	`TCGCContext`.`__httpOperationExamples`
`__knownScalars?`	`Record`<`string`, `SdkBuiltInKinds`>	`TCGCContext`.`__knownScalars`
`__methodParameterCache`	`Map`<`ModelProperty`, `SdkMethodParameter`>	`TCGCContext`.`__methodParameterCache`
`__modelPropertyCache`	`Map`<`ModelProperty`, `SdkModelPropertyType`>	`TCGCContext`.`__modelPropertyCache`
`__mutatedGlobalNamespace?`	`Namespace`	`TCGCContext`.`__mutatedGlobalNamespace`
`__operationToClientCache?`	`Map`<`Operation`, `SdkClient` \| `SdkOperationGroup`>	`TCGCContext`.`__operationToClientCache`
`__packageVersionEnum?`	`Enum`	`TCGCContext`.`__packageVersionEnum`
`__packageVersions?`	`string`[]	`TCGCContext`.`__packageVersions`
`__pagedResultSet`	`Set`<`SdkType`>	`TCGCContext`.`__pagedResultSet`
`__rawClientsOperationGroupsCache?`	`Map`<`string` \| `Interface` \| `Namespace`, `SdkClient` \| `SdkOperationGroup`>	`TCGCContext`.`__rawClientsOperationGroupsCache`
`__referencedTypeCache`	`Map`<`Type`, \| `SdkModelType` \| `SdkEnumType` \| `SdkNullableType` \| `SdkUnionType`<`SdkType`>>	`TCGCContext`.`__referencedTypeCache`
`__responseHeaderCache`	`Map`<`ModelProperty`, `SdkServiceResponseHeader`>	`TCGCContext`.`__responseHeaderCache`
`__tspTypeToApiVersions`	`Map`<`Type`, `string`[]>	`TCGCContext`.`__tspTypeToApiVersions`
`apiVersion?`	`string`	`TCGCContext`.`apiVersion`
`arm?`	`boolean`	`TCGCContext`.`arm`
`decoratorsAllowList?`	`string`[]	`TCGCContext`.`decoratorsAllowList`
`diagnostics`	readonly `Diagnostic`[]	`TCGCContext`.`diagnostics`
`disableUsageAccessPropagationToBase`	`boolean`	`TCGCContext`.`disableUsageAccessPropagationToBase`
`emitContext`	`EmitContext`<`TOptions`>	-
`emitterName`	`string`	`TCGCContext`.`emitterName`
`enableLegacyHierarchyBuilding?`	`boolean`	`TCGCContext`.`enableLegacyHierarchyBuilding`
`examplesDir?`	`string`	`TCGCContext`.`examplesDir`
`flattenUnionAsEnum?`	`boolean`	`TCGCContext`.`flattenUnionAsEnum`
`generateConvenienceMethods?`	`boolean`	`TCGCContext`.`generateConvenienceMethods`
`generateProtocolMethods?`	`boolean`	`TCGCContext`.`generateProtocolMethods`
`license?`	`object`	`TCGCContext`.`license`
`license.company?`	`string`	-
`license.description?`	`string`	-
`license.header?`	`string`	-
`license.link?`	`string`	-
`license.name`	`string`	-
`namespaceFlag?`	`string`	`TCGCContext`.`namespaceFlag`
`previewStringRegex`	`RegExp`	`TCGCContext`.`previewStringRegex`
`program`	`Program`	`TCGCContext`.`program`
`sdkPackage`	`SdkPackage`<`TServiceOperation`>	-

Methods

getApiVersionsForType()

getApiVersionsForType(type): string[];

Parameters

Parameter	Type
`type`	`Type`

Returns

string[]

Inherited from

TCGCContext.getApiVersionsForType

getClientForOperation()

getClientForOperation(operation): SdkClient | SdkOperationGroup;

Parameters

Parameter	Type
`operation`	`Operation`

Returns

SdkClient | SdkOperationGroup

Inherited from

TCGCContext.getClientForOperation

getClientOrOperationGroup()

getClientOrOperationGroup(type):
  | SdkClient
  | SdkOperationGroup
  | undefined;

Parameters

Parameter	Type
`type`	`Interface` \| `Namespace`

Returns

| SdkClient | SdkOperationGroup | undefined

Inherited from

TCGCContext.getClientOrOperationGroup

getClients()

getClients(): SdkClient[];

Returns

SdkClient[]

Inherited from

TCGCContext.getClients

getMutatedGlobalNamespace()

getMutatedGlobalNamespace(): Namespace;

Returns

Namespace

Inherited from

TCGCContext.getMutatedGlobalNamespace

getOperationsForClient()

getOperationsForClient(client): Operation[];

Parameters

Parameter	Type
`client`	`SdkClient` \| `SdkOperationGroup`

Returns

Operation[]

Inherited from

TCGCContext.getOperationsForClient

getPackageVersionEnum()

getPackageVersionEnum(): Enum | undefined;

Returns

Enum | undefined

Inherited from

TCGCContext.getPackageVersionEnum

getPackageVersions()

getPackageVersions(): string[];

Returns

string[]

Inherited from

TCGCContext.getPackageVersions

setApiVersionsForType()

setApiVersionsForType(type, apiVersions): void;

Parameters

Parameter	Type
`type`	`Type`
`apiVersions`	`string`[]

Returns

void

Inherited from

TCGCContext.setApiVersionsForType