From 413db2a532676432c74ec2a2857d9dad4a0b6152 Mon Sep 17 00:00:00 2001 From: Timothee Guerin Date: Tue, 5 Mar 2024 16:13:25 -0800 Subject: [PATCH] Bump versions for release march 2024 (#370) --- ...AdditionalProperties-2024-1-23-10-13-55.md | 7 - .../add_azure_location-2024-1-29-16-5-38.md | 7 - .../add_azure_location-2024-2-4-12-13-28.md | 7 - .../add_flatten_to_prop-2024-1-22-17-28-18.md | 7 - .../add_on_validate-2024-1-26-14-11-57.md | 7 - .../add_operation_status-2024-1-23-16-6-53.md | 7 - .../anonymous_union_enum-2024-1-29-16-5-25.md | 7 - .../azhang_ArmHead-2024-1-20-8-59-26.md | 7 - ...ng_provisioningState-2024-1-27-10-36-42.md | 7 - ...eteResponseCodesRule-2024-1-22-15-13-34.md | 7 - ...bmodules-core-717af64-2024-1-29-10-7-42.md | 7 - ...ubmodules-core-717af64-2024-1-29-10-8-7.md | 7 - ...ubmodules-core-afd3772-2024-1-9-8-55-23.md | 6 - .../enum-value-type-2024-2-5-16-25-35.md | 7 - ...canonical-versioning-2024-1-26-22-11-28.md | 8 - ...missing-x-ms-id-rule-2024-1-23-17-39-50.md | 8 - .../changes/fix-put-templ-2024-2-5-19-5-5.md | 8 - .../fix_azure_scalars-2024-1-29-18-19-4.md | 7 - .../fix_client_name-2024-1-26-23-27-21.md | 7 - .../fix_union_variant-2024-1-28-18-32-18.md | 7 - ...additional_properties-2024-1-23-18-7-29.md | 7 - .../changes/flatten-2024-1-20-11-30-53.md | 7 - ...rossLanguagePackageId-2024-2-1-14-13-36.md | 7 - .../ignore_diagnostics-2024-1-23-17-59-25.md | 7 - .chronus/changes/main-2024-2-1-3-41-58.md | 7 - ...ate-providerhub-rules-2024-1-9-20-38-59.md | 8 - ...ate-providerhub-rules-2024-1-9-20-38-60.md | 8 - .../next-link-read-only-2024-1-28-21-59-17.md | 8 - .../prevent_breaking-2024-1-28-17-11-9.md | 7 - ...ll_back_envelope_arm-2024-1-26-14-26-53.md | 7 - .../union_discriminator-2024-1-13-16-23-22.md | 7 - .../unknown_format-2024-1-20-16-12-31.md | 7 - ...dependencies-feb-2024-2024-1-8-21-32-48.md | 12 - .../changes/update_doc-2024-1-18-15-55-46.md | 7 - .../uptake-code-fixes-2024-2-5-18-15-42.md | 8 - ...uptake-ref-docs-models-2024-1-24-2-57-3.md | 10 - .../use_diagnostics-2024-1-14-18-46-55.md | 5 - .../changes/utc_info-2024-1-22-17-11-48.md | 7 - .../yejeelee-promotions-2024-1-21-1-4-17.md | 7 - core | 2 +- eng/scripts/prepare-publish.js | 120 ---- packages/typespec-autorest/CHANGELOG.md | 13 +- packages/typespec-autorest/package.json | 2 +- packages/typespec-azure-core/CHANGELOG.md | 17 +- packages/typespec-azure-core/package.json | 2 +- .../typespec-azure-portal-core/CHANGELOG.md | 14 + .../typespec-azure-portal-core/package.json | 2 +- .../CHANGELOG.md | 20 +- .../package.json | 2 +- .../CHANGELOG.md | 33 +- .../package.json | 2 +- packages/website/playground-versions.json | 1 + .../emitters/typespec-autorest/index.md | 2 +- .../typespec-autorest/reference/decorators.md | 16 +- .../reference/js-api/interfaces/Example.md | 8 +- .../js-api/interfaces/RefProducerParams.md | 8 +- .../reference/js-api/variables/$lib.md | 24 +- .../js-api/functions/reportDiagnostic.md | 2 +- .../reference/js-api/variables/$lib.md | 2 +- .../azure-resource-manager/step00.md | 2 +- .../azure-resource-manager/step02.md | 2 +- .../version-latest/getstarted/installation.md | 2 +- .../howtos/ARM/resource-type.md | 14 +- .../howtos/Azure Core/content-negotiation.md | 2 +- .../howtos/migrate-swagger/x-ms-examples.md | 55 ++ .../versioned_docs/version-latest/intro.md | 2 +- .../azure-core/reference/data-types.md | 398 ++++++++++ .../azure-core/reference/decorators.md | 76 +- .../azure-core/reference/interfaces.md | 14 +- .../js-api/enumerations/FinalStateValue.md | 2 +- .../js-api/enumerations/pollingOptionsKind.md | 2 +- .../js-api/functions/$lroCanceled.md | 2 +- .../reference/js-api/functions/$lroFailed.md | 2 +- .../reference/js-api/functions/$lroStatus.md | 2 +- .../js-api/functions/$lroSucceeded.md | 2 +- .../js-api/functions/isLroCanceledState.md | 2 +- .../js-api/functions/isLroFailedState.md | 2 +- .../js-api/functions/isLroSucceededState.md | 2 +- .../interfaces/EmbeddingVectorMetadata.md | 6 +- .../js-api/interfaces/FinalOperationLink.md | 4 +- .../interfaces/FinalOperationReference.md | 4 +- .../interfaces/HttpTerminationStatus.md | 6 +- .../js-api/interfaces/LogicalOperationStep.md | 2 +- .../js-api/interfaces/LongRunningStates.md | 12 +- .../js-api/interfaces/LroMetadata.md | 2 +- .../js-api/interfaces/NextOperationLink.md | 4 +- .../interfaces/NextOperationReference.md | 4 +- .../interfaces/NoPollingSuccessProperty.md | 4 +- .../interfaces/OperationLinkMetadata.md | 16 +- .../js-api/interfaces/PollingLocationBase.md | 2 +- .../js-api/interfaces/PollingOperationStep.md | 4 +- .../interfaces/PollingSuccessNoResult.md | 4 +- .../interfaces/PollingSuccessProperty.md | 4 +- .../StatusMonitorPollingLocationInfo.md | 14 +- .../reference/js-api/variables/$lib.md | 28 +- .../libraries/azure-core/reference/linter.md | 22 +- .../libraries/azure-core/rules/no-enum.md | 9 + .../rules/non-breaking-versioning.md | 72 ++ .../azure-portal-core/reference/data-types.md | 113 +++ .../azure-portal-core/reference/decorators.md | 100 +++ .../azure-portal-core/reference/index.mdx | 54 ++ .../reference/js-api/_category_.json | 1 + .../reference/js-api/functions/$about.md | 25 + .../reference/js-api/functions/$browse.md | 25 + .../js-api/functions/$displayName.md | 23 + .../js-api/functions/$marketplaceOffer.md | 23 + .../reference/js-api/functions/$onValidate.md | 18 + .../reference/js-api/functions/$promotion.md | 23 + .../js-api/functions/checkIsArmResource.md | 23 + .../functions/checkIsValidApiVersion.md | 23 + .../reference/js-api/functions/getAbout.md | 19 + .../js-api/functions/getAboutDisplayNames.md | 19 + .../js-api/functions/getAboutKeywords.md | 19 + .../js-api/functions/getAboutLearnMoreDocs.md | 19 + .../reference/js-api/functions/getBrowse.md | 19 + .../js-api/functions/getBrowseArgQuery.md | 19 + .../js-api/functions/getDisplayName.md | 19 + .../js-api/functions/getMarketplaceOfferId.md | 19 + .../js-api/functions/getPromotion.md | 19 + .../reference/js-api/functions/isFileExist.md | 19 + .../reference/js-api/index.md | 41 ++ .../js-api/interfaces/AboutOptions.md | 14 + .../js-api/interfaces/BrowseOptions.md | 10 + .../js-api/interfaces/DisplayNamesOptions.md | 11 + .../reference/js-api/interfaces/FilePath.md | 10 + .../js-api/interfaces/LearnMoreDocsOptions.md | 11 + .../interfaces/MarketplaceOfferOptions.md | 10 + .../js-api/interfaces/PromotionOptions.md | 11 + .../reference/js-api/variables/$lib.md | 32 + .../js-api/variables/PortalCoreKeys.md | 13 + .../reference/js-api/variables/namespace.md | 8 + .../reference/data-types.md | 677 ++++++++++++++++++ .../reference/decorators.md | 54 +- .../reference/index.mdx | 3 + .../reference/interfaces.md | 176 +++-- .../js-api/enumerations/ResourceBaseType.md | 2 +- .../reference/js-api/index.md | 1 + .../interfaces/ArmCommonTypeVersions.md | 8 +- .../interfaces/ArmLifecycleOperations.md | 12 +- .../js-api/interfaces/ArmResourceDetails.md | 20 +- .../interfaces/ArmResourceDetailsBase.md | 18 +- .../js-api/interfaces/ArmResourceOperation.md | 16 +- .../interfaces/ArmResourceOperations.md | 10 +- .../reference/js-api/variables/$lib.md | 22 +- .../reference/js-api/variables/$linter.md | 8 + .../reference/linter.md | 53 +- .../rules/arm-resource-provisioning-state.md | 30 + .../rules/delete-operation-response-codes.md | 55 ++ .../rules/missing-x-ms-identifiers.md | 31 + .../azure-resource-manager/rules/no-record.md | 67 ++ .../reference/decorators.md | 268 +++++-- .../js-api/functions/createDiagnostic.md | 6 +- .../js-api/functions/createSdkContext.md | 2 +- .../reference/js-api/functions/getAccess.md | 2 +- .../js-api/functions/getAccessOverride.md | 2 +- .../js-api/functions/getAllModels.md | 2 +- .../functions/getAllModelsWithDiagnostics.md | 19 + .../reference/js-api/functions/getClient.md | 2 +- .../js-api/functions/getClientFormat.md | 2 +- .../js-api/functions/getClientNameOverride.md | 2 +- .../functions/getClientNamespaceString.md | 2 +- .../js-api/functions/getClientType.md | 2 +- .../functions/getClientTypeWithDiagnostics.md | 23 + .../functions/getCrossLanguagePackageId.md | 20 + .../js-api/functions/getDefaultApiVersion.md | 2 +- .../js-api/functions/getDocHelper.md | 2 +- .../functions/getEffectivePayloadType.md | 2 +- .../js-api/functions/getEmitterTargetName.md | 2 +- .../js-api/functions/getGeneratedName.md | 2 +- .../js-api/functions/getLibraryName.md | 14 +- .../js-api/functions/getOperationGroup.md | 2 +- .../js-api/functions/getPropertyNames.md | 2 +- .../js-api/functions/getSdkArrayOrDict.md | 2 +- .../getSdkArrayOrDictWithDiagnostics.md | 23 + .../js-api/functions/getSdkBuiltInType.md | 4 +- .../js-api/functions/getSdkConstant.md | 2 +- .../js-api/functions/getSdkDatetimeType.md | 19 - .../js-api/functions/getSdkDurationType.md | 2 +- .../reference/js-api/functions/getSdkEnum.md | 2 +- .../js-api/functions/getSdkEnumValue.md | 2 +- .../reference/js-api/functions/getSdkModel.md | 2 +- .../functions/getSdkModelWithDiagnostics.md | 23 + .../reference/js-api/functions/getSdkTuple.md | 2 +- .../functions/getSdkTupleWithDiagnostics.md | 23 + .../js-api/functions/getSdkTypeBaseHelper.md | 4 +- .../reference/js-api/functions/getSdkUnion.md | 6 +- .../functions/getSdkUnionWithDiagnostics.md | 23 + .../reference/js-api/functions/getUsage.md | 2 +- .../js-api/functions/getUsageOverride.md | 2 +- .../reference/js-api/functions/getWireName.md | 18 +- .../js-api/functions/isApiVersion.md | 2 +- .../js-api/functions/isErrorOrChildOfError.md | 19 + .../reference/js-api/functions/isExclude.md | 2 +- .../js-api/functions/isInOperationGroup.md | 2 +- .../reference/js-api/functions/isInclude.md | 2 +- .../reference/js-api/functions/isInternal.md | 2 +- .../js-api/functions/isOperationGroup.md | 2 +- .../reference/js-api/functions/listClients.md | 2 +- .../js-api/functions/listOperationGroups.md | 2 +- .../listOperationsInOperationGroup.md | 2 +- .../js-api/functions/reportDiagnostic.md | 6 +- .../functions/reportUnionUnsupported.md | 2 +- .../js-api/functions/shouldFlattenProperty.md | 2 +- .../functions/shouldGenerateConvenient.md | 2 +- .../functions/shouldGenerateProtocol.md | 2 +- .../reference/js-api/index.md | 11 +- .../js-api/interfaces/SdkArrayType.md | 10 +- .../interfaces/SdkBodyModelPropertyType.md | 29 +- .../js-api/interfaces/SdkBuiltInType.md | 10 +- .../reference/js-api/interfaces/SdkClient.md | 16 +- .../js-api/interfaces/SdkConstantType.md | 10 +- .../reference/js-api/interfaces/SdkContext.md | 29 +- .../js-api/interfaces/SdkDatetimeType.md | 19 - .../js-api/interfaces/SdkDictionaryType.md | 10 +- .../js-api/interfaces/SdkDurationType.md | 10 +- .../js-api/interfaces/SdkEmitterOptions.md | 12 +- .../js-api/interfaces/SdkEnumType.md | 11 +- .../js-api/interfaces/SdkEnumValueType.md | 10 +- .../interfaces/SdkModelPropertyTypeBase.md | 20 +- .../js-api/interfaces/SdkModelType.md | 11 +- .../js-api/interfaces/SdkOperationGroup.md | 12 +- .../js-api/interfaces/SdkTupleType.md | 10 +- .../js-api/interfaces/SdkUnionType.md | 10 +- .../js-api/type-aliases/SdkDatetimeType.md | 8 + .../reference/js-api/variables/$lib.md | 22 +- .../reference/azure-style-guide.md | 2 +- .../release-notes/release-2022-10-12.md | 2 +- .../release-notes/release-2022-12-07.md | 4 +- .../release-notes/release-2023-01-12.md | 2 +- .../release-notes/release-2023-02-07.md | 2 +- .../release-notes/release-2023-03-13.md | 2 +- .../release-notes/release-2023-04-11.md | 2 +- .../release-notes/release-2023-05-10.md | 2 +- .../release-notes/release-2023-06-06.md | 2 +- .../release-notes/release-2023-07-11.md | 4 +- .../release-notes/release-2023-08-08.md | 4 +- .../release-notes/release-2023-09-12.md | 4 +- .../release-notes/release-2023-10-11.md | 4 +- .../release-notes/release-2023-11-07.md | 4 +- .../release-notes/release-2023-12-06.md | 4 +- .../release-notes/release-2024-01-23.md | 4 +- .../release-notes/release-2024-03-05.md | 72 ++ .../typespec-getting-started.md | 6 +- .../version-latest-sidebars.json | 14 + 244 files changed, 3397 insertions(+), 1077 deletions(-) delete mode 100644 .chronus/changes/AvoidAdditionalProperties-2024-1-23-10-13-55.md delete mode 100644 .chronus/changes/add_azure_location-2024-1-29-16-5-38.md delete mode 100644 .chronus/changes/add_azure_location-2024-2-4-12-13-28.md delete mode 100644 .chronus/changes/add_flatten_to_prop-2024-1-22-17-28-18.md delete mode 100644 .chronus/changes/add_on_validate-2024-1-26-14-11-57.md delete mode 100644 .chronus/changes/add_operation_status-2024-1-23-16-6-53.md delete mode 100644 .chronus/changes/anonymous_union_enum-2024-1-29-16-5-25.md delete mode 100644 .chronus/changes/azhang_ArmHead-2024-1-20-8-59-26.md delete mode 100644 .chronus/changes/azhang_provisioningState-2024-1-27-10-36-42.md delete mode 100644 .chronus/changes/deleteResponseCodesRule-2024-1-22-15-13-34.md delete mode 100644 .chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-7-42.md delete mode 100644 .chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-8-7.md delete mode 100644 .chronus/changes/dependabot-submodules-core-afd3772-2024-1-9-8-55-23.md delete mode 100644 .chronus/changes/enum-value-type-2024-2-5-16-25-35.md delete mode 100644 .chronus/changes/fix-missing-canonical-versioning-2024-1-26-22-11-28.md delete mode 100644 .chronus/changes/fix-missing-x-ms-id-rule-2024-1-23-17-39-50.md delete mode 100644 .chronus/changes/fix-put-templ-2024-2-5-19-5-5.md delete mode 100644 .chronus/changes/fix_azure_scalars-2024-1-29-18-19-4.md delete mode 100644 .chronus/changes/fix_client_name-2024-1-26-23-27-21.md delete mode 100644 .chronus/changes/fix_union_variant-2024-1-28-18-32-18.md delete mode 100644 .chronus/changes/fix_usage_for_additional_properties-2024-1-23-18-7-29.md delete mode 100644 .chronus/changes/flatten-2024-1-20-11-30-53.md delete mode 100644 .chronus/changes/getCrossLanguagePackageId-2024-2-1-14-13-36.md delete mode 100644 .chronus/changes/ignore_diagnostics-2024-1-23-17-59-25.md delete mode 100644 .chronus/changes/main-2024-2-1-3-41-58.md delete mode 100644 .chronus/changes/migate-providerhub-rules-2024-1-9-20-38-59.md delete mode 100644 .chronus/changes/migate-providerhub-rules-2024-1-9-20-38-60.md delete mode 100644 .chronus/changes/next-link-read-only-2024-1-28-21-59-17.md delete mode 100644 .chronus/changes/prevent_breaking-2024-1-28-17-11-9.md delete mode 100644 .chronus/changes/roll_back_envelope_arm-2024-1-26-14-26-53.md delete mode 100644 .chronus/changes/union_discriminator-2024-1-13-16-23-22.md delete mode 100644 .chronus/changes/unknown_format-2024-1-20-16-12-31.md delete mode 100644 .chronus/changes/update-dependencies-feb-2024-2024-1-8-21-32-48.md delete mode 100644 .chronus/changes/update_doc-2024-1-18-15-55-46.md delete mode 100644 .chronus/changes/uptake-code-fixes-2024-2-5-18-15-42.md delete mode 100644 .chronus/changes/uptake-ref-docs-models-2024-1-24-2-57-3.md delete mode 100644 .chronus/changes/use_diagnostics-2024-1-14-18-46-55.md delete mode 100644 .chronus/changes/utc_info-2024-1-22-17-11-48.md delete mode 100644 .chronus/changes/yejeelee-promotions-2024-1-21-1-4-17.md create mode 100644 packages/typespec-azure-portal-core/CHANGELOG.md create mode 100644 packages/website/versioned_docs/version-latest/howtos/migrate-swagger/x-ms-examples.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-core/rules/non-breaking-versioning.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/data-types.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/decorators.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/index.mdx create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/_category_.json create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$about.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$browse.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$displayName.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$marketplaceOffer.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$onValidate.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$promotion.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsArmResource.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsValidApiVersion.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAbout.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutDisplayNames.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutKeywords.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutLearnMoreDocs.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowse.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowseArgQuery.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getDisplayName.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getMarketplaceOfferId.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getPromotion.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/isFileExist.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/AboutOptions.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/BrowseOptions.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/DisplayNamesOptions.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/FilePath.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/LearnMoreDocsOptions.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/MarketplaceOfferOptions.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/PromotionOptions.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/$lib.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/PortalCoreKeys.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/namespace.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$linter.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/arm-resource-provisioning-state.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/delete-operation-response-codes.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/missing-x-ms-identifiers.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-record.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModelsWithDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientTypeWithDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getCrossLanguagePackageId.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDictWithDiagnostics.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDatetimeType.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModelWithDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTupleWithDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnionWithDiagnostics.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isErrorOrChildOfError.md delete mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md create mode 100644 packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkDatetimeType.md create mode 100644 packages/website/versioned_docs/version-latest/release-notes/release-2024-03-05.md diff --git a/.chronus/changes/AvoidAdditionalProperties-2024-1-23-10-13-55.md b/.chronus/changes/AvoidAdditionalProperties-2024-1-23-10-13-55.md deleted file mode 100644 index 3a41df0cf2..0000000000 --- a/.chronus/changes/AvoidAdditionalProperties-2024-1-23-10-13-55.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Add `arm-no-record` rule. diff --git a/.chronus/changes/add_azure_location-2024-1-29-16-5-38.md b/.chronus/changes/add_azure_location-2024-1-29-16-5-38.md deleted file mode 100644 index 2f31554b3a..0000000000 --- a/.chronus/changes/add_azure_location-2024-1-29-16-5-38.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-core" ---- - -Add new `azureLocation` scalar \ No newline at end of file diff --git a/.chronus/changes/add_azure_location-2024-2-4-12-13-28.md b/.chronus/changes/add_azure_location-2024-2-4-12-13-28.md deleted file mode 100644 index 60a628e690..0000000000 --- a/.chronus/changes/add_azure_location-2024-2-4-12-13-28.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add support for azureLocation scalar in azure core \ No newline at end of file diff --git a/.chronus/changes/add_flatten_to_prop-2024-1-22-17-28-18.md b/.chronus/changes/add_flatten_to_prop-2024-1-22-17-28-18.md deleted file mode 100644 index a18eeaa65e..0000000000 --- a/.chronus/changes/add_flatten_to_prop-2024-1-22-17-28-18.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add flattened property onto SdkBodyModelPropertyType \ No newline at end of file diff --git a/.chronus/changes/add_on_validate-2024-1-26-14-11-57.md b/.chronus/changes/add_on_validate-2024-1-26-14-11-57.md deleted file mode 100644 index bd8dd46b3c..0000000000 --- a/.chronus/changes/add_on_validate-2024-1-26-14-11-57.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add validation on import of tcgc and remove duplicate validation warnings \ No newline at end of file diff --git a/.chronus/changes/add_operation_status-2024-1-23-16-6-53.md b/.chronus/changes/add_operation_status-2024-1-23-16-6-53.md deleted file mode 100644 index 7f1993b823..0000000000 --- a/.chronus/changes/add_operation_status-2024-1-23-16-6-53.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -getAllModels will return models only used as final envelope results in non-ARM definitions diff --git a/.chronus/changes/anonymous_union_enum-2024-1-29-16-5-25.md b/.chronus/changes/anonymous_union_enum-2024-1-29-16-5-25.md deleted file mode 100644 index 2f637b926a..0000000000 --- a/.chronus/changes/anonymous_union_enum-2024-1-29-16-5-25.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -unions with only null and another type will not be converted to union \ No newline at end of file diff --git a/.chronus/changes/azhang_ArmHead-2024-1-20-8-59-26.md b/.chronus/changes/azhang_ArmHead-2024-1-20-8-59-26.md deleted file mode 100644 index 8344911adb..0000000000 --- a/.chronus/changes/azhang_ArmHead-2024-1-20-8-59-26.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Added `ArmResourceHead` operation template diff --git a/.chronus/changes/azhang_provisioningState-2024-1-27-10-36-42.md b/.chronus/changes/azhang_provisioningState-2024-1-27-10-36-42.md deleted file mode 100644 index 66fdec7577..0000000000 --- a/.chronus/changes/azhang_provisioningState-2024-1-27-10-36-42.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Adding `@visibility("read")` & optional linting rules linting rules for ARM `provisioningState` \ No newline at end of file diff --git a/.chronus/changes/deleteResponseCodesRule-2024-1-22-15-13-34.md b/.chronus/changes/deleteResponseCodesRule-2024-1-22-15-13-34.md deleted file mode 100644 index 9a74465d8c..0000000000 --- a/.chronus/changes/deleteResponseCodesRule-2024-1-22-15-13-34.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -ARM: add `arm-delete-response-codes` rule. \ No newline at end of file diff --git a/.chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-7-42.md b/.chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-7-42.md deleted file mode 100644 index ce4bba4876..0000000000 --- a/.chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-7-42.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-azure-resource-manager" - - "@azure-tools/typespec-client-generator-core" ---- - diff --git a/.chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-8-7.md b/.chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-8-7.md deleted file mode 100644 index 9dc50784c2..0000000000 --- a/.chronus/changes/dependabot-submodules-core-717af64-2024-1-29-10-8-7.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-autorest" ---- - -Add support for all properties of openapi `info` object on the `@info` decorator \ No newline at end of file diff --git a/.chronus/changes/dependabot-submodules-core-afd3772-2024-1-9-8-55-23.md b/.chronus/changes/dependabot-submodules-core-afd3772-2024-1-9-8-55-23.md deleted file mode 100644 index 40b3c23d94..0000000000 --- a/.chronus/changes/dependabot-submodules-core-afd3772-2024-1-9-8-55-23.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-client-generator-core" ---- - diff --git a/.chronus/changes/enum-value-type-2024-2-5-16-25-35.md b/.chronus/changes/enum-value-type-2024-2-5-16-25-35.md deleted file mode 100644 index 7b4f525207..0000000000 --- a/.chronus/changes/enum-value-type-2024-2-5-16-25-35.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -enhance logic for value type of enum and union as enum \ No newline at end of file diff --git a/.chronus/changes/fix-missing-canonical-versioning-2024-1-26-22-11-28.md b/.chronus/changes/fix-missing-canonical-versioning-2024-1-26-22-11-28.md deleted file mode 100644 index c5fe1b1a8f..0000000000 --- a/.chronus/changes/fix-missing-canonical-versioning-2024-1-26-22-11-28.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Add ruleset `canonical-versioning` to Azure Resource Manager library. diff --git a/.chronus/changes/fix-missing-x-ms-id-rule-2024-1-23-17-39-50.md b/.chronus/changes/fix-missing-x-ms-id-rule-2024-1-23-17-39-50.md deleted file mode 100644 index 51df349385..0000000000 --- a/.chronus/changes/fix-missing-x-ms-id-rule-2024-1-23-17-39-50.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Fix `missing-x-ms-identifiers` rule triggering for every `enum` diff --git a/.chronus/changes/fix-put-templ-2024-2-5-19-5-5.md b/.chronus/changes/fix-put-templ-2024-2-5-19-5-5.md deleted file mode 100644 index d806a88d8b..0000000000 --- a/.chronus/changes/fix-put-templ-2024-2-5-19-5-5.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Fix for issue #254 cannot customize response in ARM PUT templates diff --git a/.chronus/changes/fix_azure_scalars-2024-1-29-18-19-4.md b/.chronus/changes/fix_azure_scalars-2024-1-29-18-19-4.md deleted file mode 100644 index 022f542329..0000000000 --- a/.chronus/changes/fix_azure_scalars-2024-1-29-18-19-4.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -clean up code for built in kidns and format \ No newline at end of file diff --git a/.chronus/changes/fix_client_name-2024-1-26-23-27-21.md b/.chronus/changes/fix_client_name-2024-1-26-23-27-21.md deleted file mode 100644 index 5904e69941..0000000000 --- a/.chronus/changes/fix_client_name-2024-1-26-23-27-21.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -support @clientName for extensible enum variant \ No newline at end of file diff --git a/.chronus/changes/fix_union_variant-2024-1-28-18-32-18.md b/.chronus/changes/fix_union_variant-2024-1-28-18-32-18.md deleted file mode 100644 index 00cc525903..0000000000 --- a/.chronus/changes/fix_union_variant-2024-1-28-18-32-18.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add support for anonymous union as enum and fix union as enum variant discriminator typing problem \ No newline at end of file diff --git a/.chronus/changes/fix_usage_for_additional_properties-2024-1-23-18-7-29.md b/.chronus/changes/fix_usage_for_additional_properties-2024-1-23-18-7-29.md deleted file mode 100644 index c94b8f2e7c..0000000000 --- a/.chronus/changes/fix_usage_for_additional_properties-2024-1-23-18-7-29.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -Add usage calculation for additional properties with model type \ No newline at end of file diff --git a/.chronus/changes/flatten-2024-1-20-11-30-53.md b/.chronus/changes/flatten-2024-1-20-11-30-53.md deleted file mode 100644 index 01e62940e7..0000000000 --- a/.chronus/changes/flatten-2024-1-20-11-30-53.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-autorest" ---- - -Support `@flattenProperty` decorator. diff --git a/.chronus/changes/getCrossLanguagePackageId-2024-2-1-14-13-36.md b/.chronus/changes/getCrossLanguagePackageId-2024-2-1-14-13-36.md deleted file mode 100644 index 4c846768fb..0000000000 --- a/.chronus/changes/getCrossLanguagePackageId-2024-2-1-14-13-36.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add helper function getCrossLanguagePackageId. getCrossLanguagePackageId returns a package id that is consistent across languages, allowing emitters to identify that they are generating from the same service tsp \ No newline at end of file diff --git a/.chronus/changes/ignore_diagnostics-2024-1-23-17-59-25.md b/.chronus/changes/ignore_diagnostics-2024-1-23-17-59-25.md deleted file mode 100644 index 36033c72eb..0000000000 --- a/.chronus/changes/ignore_diagnostics-2024-1-23-17-59-25.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -add getClientTypeWithDiagnostics and getAllModelsWithDiagnostics to get values back with diagnostics \ No newline at end of file diff --git a/.chronus/changes/main-2024-2-1-3-41-58.md b/.chronus/changes/main-2024-2-1-3-41-58.md deleted file mode 100644 index 542e9c8633..0000000000 --- a/.chronus/changes/main-2024-2-1-3-41-58.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-azure-portal-core" ---- - -fixing @about learnMoreDocs to different type \ No newline at end of file diff --git a/.chronus/changes/migate-providerhub-rules-2024-1-9-20-38-59.md b/.chronus/changes/migate-providerhub-rules-2024-1-9-20-38-59.md deleted file mode 100644 index 3ac8404633..0000000000 --- a/.chronus/changes/migate-providerhub-rules-2024-1-9-20-38-59.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@azure-tools/typespec-azure-resource-manager" ---- - -Added new rule `missing-x-ms-identifiers` (Migrated from typespec-providerhub package) diff --git a/.chronus/changes/migate-providerhub-rules-2024-1-9-20-38-60.md b/.chronus/changes/migate-providerhub-rules-2024-1-9-20-38-60.md deleted file mode 100644 index 24e05a9af6..0000000000 --- a/.chronus/changes/migate-providerhub-rules-2024-1-9-20-38-60.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@azure-tools/typespec-azure-core" ---- - -Added new non-breaking-versioning linter rule in a new canonical-versioing ruleset diff --git a/.chronus/changes/next-link-read-only-2024-1-28-21-59-17.md b/.chronus/changes/next-link-read-only-2024-1-28-21-59-17.md deleted file mode 100644 index fcaa0d26c7..0000000000 --- a/.chronus/changes/next-link-read-only-2024-1-28-21-59-17.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@azure-tools/typespec-azure-core" ---- - -Azure `Page` type `nextLink` properties are now marked as `readonly` diff --git a/.chronus/changes/prevent_breaking-2024-1-28-17-11-9.md b/.chronus/changes/prevent_breaking-2024-1-28-17-11-9.md deleted file mode 100644 index b7560c3c11..0000000000 --- a/.chronus/changes/prevent_breaking-2024-1-28-17-11-9.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -rollback some of the breaking changes for common model types method \ No newline at end of file diff --git a/.chronus/changes/roll_back_envelope_arm-2024-1-26-14-26-53.md b/.chronus/changes/roll_back_envelope_arm-2024-1-26-14-26-53.md deleted file mode 100644 index 7b9515f5fe..0000000000 --- a/.chronus/changes/roll_back_envelope_arm-2024-1-26-14-26-53.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -fix duplicate errors when generating with arm lro template \ No newline at end of file diff --git a/.chronus/changes/union_discriminator-2024-1-13-16-23-22.md b/.chronus/changes/union_discriminator-2024-1-13-16-23-22.md deleted file mode 100644 index e537341ca6..0000000000 --- a/.chronus/changes/union_discriminator-2024-1-13-16-23-22.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -allow models to have a union variant as a discriminator \ No newline at end of file diff --git a/.chronus/changes/unknown_format-2024-1-20-16-12-31.md b/.chronus/changes/unknown_format-2024-1-20-16-12-31.md deleted file mode 100644 index 5d405e1421..0000000000 --- a/.chronus/changes/unknown_format-2024-1-20-16-12-31.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -don't throw for unknown format \ No newline at end of file diff --git a/.chronus/changes/update-dependencies-feb-2024-2024-1-8-21-32-48.md b/.chronus/changes/update-dependencies-feb-2024-2024-1-8-21-32-48.md deleted file mode 100644 index 4b015f188b..0000000000 --- a/.chronus/changes/update-dependencies-feb-2024-2024-1-8-21-32-48.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: dependencies -packages: - - "@azure-tools/typespec-autorest" - - "@azure-tools/typespec-azure-core" - - "@azure-tools/typespec-azure-portal-core" - - "@azure-tools/typespec-azure-resource-manager" - - "@azure-tools/typespec-client-generator-core" ---- - -Update dependencies diff --git a/.chronus/changes/update_doc-2024-1-18-15-55-46.md b/.chronus/changes/update_doc-2024-1-18-15-55-46.md deleted file mode 100644 index 594f8a85f6..0000000000 --- a/.chronus/changes/update_doc-2024-1-18-15-55-46.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -Update doc for `@access` and `@usage` \ No newline at end of file diff --git a/.chronus/changes/uptake-code-fixes-2024-2-5-18-15-42.md b/.chronus/changes/uptake-code-fixes-2024-2-5-18-15-42.md deleted file mode 100644 index 8ab90321e7..0000000000 --- a/.chronus/changes/uptake-code-fixes-2024-2-5-18-15-42.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@azure-tools/typespec-azure-core" ---- - -Implement code fixes for `no-enum` linter rule diff --git a/.chronus/changes/uptake-ref-docs-models-2024-1-24-2-57-3.md b/.chronus/changes/uptake-ref-docs-models-2024-1-24-2-57-3.md deleted file mode 100644 index 2d50cce33a..0000000000 --- a/.chronus/changes/uptake-ref-docs-models-2024-1-24-2-57-3.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@azure-tools/typespec-azure-core" - - "@azure-tools/typespec-azure-portal-core" - - "@azure-tools/typespec-azure-resource-manager" - - "@azure-tools/typespec-client-generator-core" - - "@azure-tools/typespec-autorest" ---- diff --git a/.chronus/changes/use_diagnostics-2024-1-14-18-46-55.md b/.chronus/changes/use_diagnostics-2024-1-14-18-46-55.md deleted file mode 100644 index 128bce490f..0000000000 --- a/.chronus/changes/use_diagnostics-2024-1-14-18-46-55.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -changeKind: internal -packages: - - "@azure-tools/typespec-client-generator-core" ---- diff --git a/.chronus/changes/utc_info-2024-1-22-17-11-48.md b/.chronus/changes/utc_info-2024-1-22-17-11-48.md deleted file mode 100644 index c9b41d1205..0000000000 --- a/.chronus/changes/utc_info-2024-1-22-17-11-48.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: breaking -packages: - - "@azure-tools/typespec-client-generator-core" ---- - -Split datetime type into utcDateTime and offsetDateTime to remain in sync with tsp \ No newline at end of file diff --git a/.chronus/changes/yejeelee-promotions-2024-1-21-1-4-17.md b/.chronus/changes/yejeelee-promotions-2024-1-21-1-4-17.md deleted file mode 100644 index b9da6f48f2..0000000000 --- a/.chronus/changes/yejeelee-promotions-2024-1-21-1-4-17.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@azure-tools/typespec-azure-portal-core" ---- - -adding new decorator called `@promotion` and adding validation rule for `@about.LearnMoreDocs` \ No newline at end of file diff --git a/core b/core index 4cafd969de..9881002f1c 160000 --- a/core +++ b/core @@ -1 +1 @@ -Subproject commit 4cafd969de7fb9794be7fcf5380fe2e189aaba3d +Subproject commit 9881002f1c26ab6cc9e1ff6f0a485c1d4f54a3af diff --git a/eng/scripts/prepare-publish.js b/eng/scripts/prepare-publish.js index dbc0256aac..c8168cf15a 100644 --- a/eng/scripts/prepare-publish.js +++ b/eng/scripts/prepare-publish.js @@ -1,6 +1,4 @@ // @ts-check -import { mkdirSync, writeFileSync } from "fs"; -import { join } from "path"; import pc from "picocolors"; import { parseArgs } from "util"; import { runOrExit } from "../../core/packages/internal-build-utils/dist/src/common.js"; @@ -94,9 +92,6 @@ log("Bumping cross-submodule dependencies"); // Determine project versions including any bumps from typespec publish above const versions = await getProjectVersions(); -// Bump typespec-azure -> typespec dependencies. -await bumpCrossSubmoduleDependencies(); - // Stage typespec-azure publish await typespecAzureRun("pnpm", "change", "version"); if (!args.values.onlyBumpVersions) { @@ -203,56 +198,6 @@ async function getProjectVersions() { return map; } -async function bumpCrossSubmoduleDependencies() { - logRegionStart("Bumping cross-submodule dependencies"); - let changed = false; - - const packages = await listPackages(); - - for (const project of packages.filter((x) => !x.dir.startsWith(coreRepoRoot))) { - log("Checking if deps needs to be bump for project: ", project.manifest.name); - - const pkgJson = { ...project.manifest }; - - const change = bumpDependencies(pkgJson); - - if (change == NoChange) { - continue; - } - logSuccess(`Project ${project.manifest.name} changed saving package.json.`); - - writeFileSync(join(project.dir, "package.json"), JSON.stringify(pkgJson, undefined, 2) + "\n"); - - if (project.manifest.private === false) { - continue; - } - - const changelog = [ - "---", - `"changeKind: ${change === Major ? "breaking" : change === Minor ? "feature" : "fix"}"`, - `packages:`, - ` - "${project.manifest.name}"`, - "---", - "Update dependencies.", - ].join("\n"); - - const changelogDir = join(repoRoot, ".chronus/changes"); - mkdirSync(changelogDir, { recursive: true }); - - if (production) { - writeFileSync(join(changelogDir, branch.replace("/", "-") + ".md"), changelog + "\n"); - } - - changed = true; - } - logRegionEnd(); - - if (changed && production) { - await typespecAzureRun("git", "add", "-A"); - await typespecAzureRun("git", "commit", "-m", "Bump cross-submodule dependencies"); - } -} - async function rebuildAndRegenSamplesToBumpTemplateVersions() { await typespecAzureRunWithRetries(3, "pnpm", "install"); await typespecAzureRunWithOptions( @@ -275,68 +220,3 @@ async function rebuildAndRegenSamplesToBumpTemplateVersions() { ); } } - -function bumpDependencies(project) { - const dependencyGroups = [ - [project.dependencies, true], - [project.peerDependencies, true], - [project.devDependencies, true], - ]; - let change = NoChange; - for (const [dependencies, includeWorkspace] of dependencyGroups.filter( - ([x]) => x !== undefined - )) { - for (const [dependency, oldVersion] of Object.entries(dependencies)) { - const newVersion = versions.get(dependency); - if (newVersion && `~${newVersion}` !== oldVersion) { - if (includeWorkspace) { - dependencies[dependency] = `workspace:~${newVersion}`; - } else { - dependencies[dependency] = `~${newVersion}`; - } - change = Math.max(change, getChangeType(oldVersion, newVersion)); - } - } - } - return change; -} - -function getChangeType(oldVersion, newVersion) { - if (oldVersion.includes("*") || newVersion.includes("*")) { - return Patch; - } - const oldParts = getVersionParts(oldVersion); - const newParts = getVersionParts(newVersion); - - if (newParts.major > oldParts.major) { - return Major; - } - if (newParts.major < oldParts.major) { - throw new Error("version downgrade"); - } - if (newParts.minor > oldParts.minor) { - return Minor; - } - if (newParts.minor < oldParts.minor) { - throw new Error("version downgrade"); - } - if (newParts.patch > oldParts.patch) { - return Patch; - } - if (newParts.patch < oldParts.patch) { - throw new Error("version downgrade"); - } - return NoChange; -} - -function getVersionParts(version) { - const parts = version.match(/(\d+)\.(\d+)\.(\d+)/); - if (!parts) { - throw new Error(`Invalid version: ${version}`); - } - return { - major: Number(parts[1]), - minor: Number(parts[2]), - patch: Number(parts[3]), - }; -} diff --git a/packages/typespec-autorest/CHANGELOG.md b/packages/typespec-autorest/CHANGELOG.md index ad4589d529..432944e19c 100644 --- a/packages/typespec-autorest/CHANGELOG.md +++ b/packages/typespec-autorest/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log - @azure-tools/typespec-autorest +## 0.40.0 + +### Bump dependencies + +- [#243](https://github.com/Azure/typespec-azure/pull/243) Update dependencies + +### Features + +- [#337](https://github.com/Azure/typespec-azure/pull/337) Add support for all properties of openapi `info` object on the `@info` decorator +- [#277](https://github.com/Azure/typespec-azure/pull/277) Support `@flattenProperty` decorator. + + ## 0.39.2 ### Patch Changes @@ -26,7 +38,6 @@ - 8b072f4: Emit warning if using opendIdConnect http auth scheme - 148eee4: Update references to ARM, Add template customization parameters, add migration docs -This log was last generated on Mon, 29 Jan 2024 22:16:39 GMT and should not be manually modified. ## 0.38.1 diff --git a/packages/typespec-autorest/package.json b/packages/typespec-autorest/package.json index 713de6386d..7d58b3cb41 100644 --- a/packages/typespec-autorest/package.json +++ b/packages/typespec-autorest/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-autorest", - "version": "0.39.2", + "version": "0.40.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting openapi from the TypeSpec REST protocol binding", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-azure-core/CHANGELOG.md b/packages/typespec-azure-core/CHANGELOG.md index 454e9f1fd5..09f4ad59e9 100644 --- a/packages/typespec-azure-core/CHANGELOG.md +++ b/packages/typespec-azure-core/CHANGELOG.md @@ -1,5 +1,21 @@ # Change Log - @azure-tools/typespec-azure-core +## 0.40.0 + +### Bug Fixes + +- [#231](https://github.com/Azure/typespec-azure/pull/231) Azure `Page` type `nextLink` properties are now marked as `readonly` +- [#258](https://github.com/Azure/typespec-azure/pull/258) Implement code fixes for `no-enum` linter rule + +### Bump dependencies + +- [#243](https://github.com/Azure/typespec-azure/pull/243) Update dependencies + +### Features + +- [#341](https://github.com/Azure/typespec-azure/pull/341) Add new `azureLocation` scalar + + ## 0.39.1 ### Patch Changes @@ -16,7 +32,6 @@ - @typespec/http@0.53.0 - @typespec/rest@0.53.0 -This log was last generated on Wed, 24 Jan 2024 05:47:19 GMT and should not be manually modified. ## 0.38.0 diff --git a/packages/typespec-azure-core/package.json b/packages/typespec-azure-core/package.json index bba0fcdce0..9d47e06f8e 100644 --- a/packages/typespec-azure-core/package.json +++ b/packages/typespec-azure-core/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-core", - "version": "0.39.1", + "version": "0.40.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Core library", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-azure-portal-core/CHANGELOG.md b/packages/typespec-azure-portal-core/CHANGELOG.md new file mode 100644 index 0000000000..9bf282a886 --- /dev/null +++ b/packages/typespec-azure-portal-core/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog - @azure-tools/typespec-azure-portal-core + + + +## 0.40.0 + +### Bump dependencies + +- [#243](https://github.com/Azure/typespec-azure/pull/243) Update dependencies + +### Features + +- [#287](https://github.com/Azure/typespec-azure/pull/287) adding new decorator called `@promotion` and adding validation rule for `@about.LearnMoreDocs` + diff --git a/packages/typespec-azure-portal-core/package.json b/packages/typespec-azure-portal-core/package.json index 32e0dd5534..ffa4889234 100644 --- a/packages/typespec-azure-portal-core/package.json +++ b/packages/typespec-azure-portal-core/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-portal-core", - "version": "0.39.0", + "version": "0.40.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Portal Core library", "license": "MIT", diff --git a/packages/typespec-azure-resource-manager/CHANGELOG.md b/packages/typespec-azure-resource-manager/CHANGELOG.md index f13d46b238..e3ef69565a 100644 --- a/packages/typespec-azure-resource-manager/CHANGELOG.md +++ b/packages/typespec-azure-resource-manager/CHANGELOG.md @@ -1,5 +1,24 @@ # Change Log - @azure-tools/typespec-azure-resource-manager +## 0.40.0 + +### Bug Fixes + +- [#323](https://github.com/Azure/typespec-azure/pull/323) Adding `@visibility("read")` & optional linting rules linting rules for ARM `provisioningState` +- [#366](https://github.com/Azure/typespec-azure/pull/366) Fix for issue #254 cannot customize response in ARM PUT templates + +### Bump dependencies + +- [#243](https://github.com/Azure/typespec-azure/pull/243) Update dependencies + +### Features + +- [#304](https://github.com/Azure/typespec-azure/pull/304) Add `arm-no-record` rule. +- [#283](https://github.com/Azure/typespec-azure/pull/283) Added `ArmResourceHead` operation template +- [#298](https://github.com/Azure/typespec-azure/pull/298) ARM: add `arm-delete-response-codes` rule. +- [#317](https://github.com/Azure/typespec-azure/pull/317) Add ruleset `canonical-versioning` to Azure Resource Manager library. + + ## 0.39.1 ### Patch Changes @@ -13,7 +32,6 @@ - ebfe639: Fix Location resource issue, add mechanism for additional path segments - 148eee4: Update references to ARM, Add template customization parameters, add migration docs -This log was last generated on Wed, 24 Jan 2024 05:47:19 GMT and should not be manually modified. ## 0.38.0 diff --git a/packages/typespec-azure-resource-manager/package.json b/packages/typespec-azure-resource-manager/package.json index be2cf22afd..20d48fdc74 100644 --- a/packages/typespec-azure-resource-manager/package.json +++ b/packages/typespec-azure-resource-manager/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-azure-resource-manager", - "version": "0.39.1", + "version": "0.40.0", "author": "Microsoft Corporation", "description": "TypeSpec Azure Resource Manager library", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/typespec-client-generator-core/CHANGELOG.md b/packages/typespec-client-generator-core/CHANGELOG.md index a3bcc1d730..83e4258859 100644 --- a/packages/typespec-client-generator-core/CHANGELOG.md +++ b/packages/typespec-client-generator-core/CHANGELOG.md @@ -1,5 +1,37 @@ # Change Log - @azure-tools/typespec-client-generator-core +## 0.40.0 + +### Bug Fixes + +- [#305](https://github.com/Azure/typespec-azure/pull/305) getAllModels will return models only used as final envelope results in non-ARM definitions +- [#335](https://github.com/Azure/typespec-azure/pull/335) unions with only null and another type will not be converted to union +- [#362](https://github.com/Azure/typespec-azure/pull/362) enhance logic for value type of enum and union as enum +- [#314](https://github.com/Azure/typespec-azure/pull/314) support @clientName for extensible enum variant +- [#328](https://github.com/Azure/typespec-azure/pull/328) add support for anonymous union as enum and fix union as enum variant discriminator typing problem +- [#301](https://github.com/Azure/typespec-azure/pull/301) Add usage calculation for additional properties with model type +- [#327](https://github.com/Azure/typespec-azure/pull/327) rollback some of the breaking changes for common model types method +- [#260](https://github.com/Azure/typespec-azure/pull/260) allow models to have a union variant as a discriminator +- [#286](https://github.com/Azure/typespec-azure/pull/286) don't throw for unknown format +- [#274](https://github.com/Azure/typespec-azure/pull/274) Update doc for `@access` and `@usage` + +### Bump dependencies + +- [#243](https://github.com/Azure/typespec-azure/pull/243) Update dependencies + +### Features + +- [#341](https://github.com/Azure/typespec-azure/pull/341) add support for azureLocation scalar in azure core +- [#242](https://github.com/Azure/typespec-azure/pull/242) add flattened property onto SdkBodyModelPropertyType +- [#315](https://github.com/Azure/typespec-azure/pull/315) add validation on import of tcgc and remove duplicate validation warnings +- [#350](https://github.com/Azure/typespec-azure/pull/350) add helper function getCrossLanguagePackageId. getCrossLanguagePackageId returns a package id that is consistent across languages, allowing emitters to identify that they are generating from the same service tsp +- [#306](https://github.com/Azure/typespec-azure/pull/306) add getClientTypeWithDiagnostics and getAllModelsWithDiagnostics to get values back with diagnostics + +### Breaking Changes + +- [#295](https://github.com/Azure/typespec-azure/pull/295) Split datetime type into utcDateTime and offsetDateTime to remain in sync with tsp + + ## 0.39.2 ### Patch Changes @@ -19,7 +51,6 @@ - 1f1864a: fix incorrect linter error for models not directly used in multipart operations -This log was last generated on Wed, 24 Jan 2024 05:47:19 GMT and should not be manually modified. ## 0.38.0 diff --git a/packages/typespec-client-generator-core/package.json b/packages/typespec-client-generator-core/package.json index d670fe878a..9809b10839 100644 --- a/packages/typespec-client-generator-core/package.json +++ b/packages/typespec-client-generator-core/package.json @@ -1,6 +1,6 @@ { "name": "@azure-tools/typespec-client-generator-core", - "version": "0.39.1", + "version": "0.40.0", "author": "Microsoft Corporation", "description": "TypeSpec Data Plane Generation library", "homepage": "https://azure.github.io/typespec-azure", diff --git a/packages/website/playground-versions.json b/packages/website/playground-versions.json index 82052f659e..2caf2ad19c 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.40.x", "0.39.x", "0.38.x", "0.37.x", diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/index.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/index.md index 36b97d5f33..db8b10a116 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/index.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/index.md @@ -74,7 +74,7 @@ or via the command line with #### `emitter-output-dir` -Set the emitter output-dir. [See here](https://microsoft.github.io/typespec/introduction/configuration#emitter-output-dir) +Set the emitter output-dir. [See here](https://typespec.io/docs/handbook/configuration#emitter-output-dir) #### `output-file` diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/decorators.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/decorators.md index 77606f3721..116ab26130 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/decorators.md @@ -24,10 +24,10 @@ toc_max_heading_level: 3 #### Parameters -| Name | Type | Description | -| --------- | ----------------------- | ---------------------------------------- | -| pathOrUri | `valueof scalar string` | path or Uri to the example file. | -| title | `valueof scalar string` | name or description of the example file. | +| Name | Type | Description | +| --------- | ---------------- | ---------------------------------------- | +| pathOrUri | `valueof string` | path or Uri to the example file. | +| title | `valueof string` | name or description of the example file. | ### `@useRef` {#@Autorest.useRef} @@ -41,10 +41,10 @@ toc_max_heading_level: 3 #### Target -`union Model | ModelProperty` +`Model | ModelProperty` #### Parameters -| Name | Type | Description | -| ------- | ----------------------- | --------------------------------- | -| jsonRef | `valueof scalar string` | path or Uri to an OpenAPI schema. | +| Name | Type | Description | +| ------- | ---------------- | --------------------------------- | +| jsonRef | `valueof string` | path or Uri to an OpenAPI schema. | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/Example.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/Example.md index 32ed01b092..9c0af28673 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/Example.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/Example.md @@ -5,7 +5,7 @@ title: "[I] Example" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `pathOrUri` | `string` | - | -| `title` | `string` | - | +| Property | Type | +| :------ | :------ | +| `pathOrUri` | `string` | +| `title` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/RefProducerParams.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/RefProducerParams.md index 0a97c51389..e720006241 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/RefProducerParams.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/interfaces/RefProducerParams.md @@ -8,7 +8,7 @@ functions may define additional parameters. ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `service?` | `Service` | - | -| `version?` | `string` | - | +| Property | Type | +| :------ | :------ | +| `service?` | `Service` | +| `version?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md index ad080343a6..aea920df13 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-autorest/reference/js-api/variables/$lib.md @@ -9,12 +9,12 @@ const $lib: TypeSpecLibrary; ## Type declaration -| Member | Type | Description | +| Member | Type | Value | | :------ | :------ | :------ | | `duplicate-body-types` | `Object` | - | -| `duplicate-body-types.default` | `"Request has multiple body types"` | - | +| `duplicate-body-types.default` | `"Request has multiple body types"` | "Request has multiple body types" | | `duplicate-example` | `Object` | - | -| `duplicate-example.default` | `"Duplicate @example declarations on operation"` | - | +| `duplicate-example.default` | `"Duplicate @example declarations on operation"` | "Duplicate @example declarations on operation" | | `duplicate-example-file` | `Object` | - | | `duplicate-example-file.default` | `CallableMessage`<[`"filename"`, `"title"`, `"operationId"`]\> | - | | `duplicate-header` | `Object` | - | @@ -26,32 +26,32 @@ const $lib: TypeSpecLibrary; | `inline-cycle` | `Object` | - | | `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | - | | `invalid-collection-format` | `Object` | - | -| `invalid-collection-format.default` | `"The format should be one of 'csv','ssv','tsv','pipes' and 'multi'."` | - | +| `invalid-collection-format.default` | `"The format should be one of 'csv','ssv','tsv','pipes' and 'multi'."` | "The format should be one of 'csv','ssv','tsv','pipes' and 'multi'." | | `invalid-default` | `Object` | - | | `invalid-default.default` | `CallableMessage`<[`"type"`]\> | - | | `invalid-format` | `Object` | - | | `invalid-format.default` | `CallableMessage`<[`"schema"`, `"format"`]\> | - | | `invalid-multi-collection-format` | `Object` | - | -| `invalid-multi-collection-format.default` | `"The 'multi' should be applied to parameter in 'query', 'header' or 'formData'."` | - | +| `invalid-multi-collection-format.default` | `"The 'multi' should be applied to parameter in 'query', 'header' or 'formData'."` | "The 'multi' should be applied to parameter in 'query', 'header' or 'formData'." | | `invalid-property-type-for-collection-format` | `Object` | - | -| `invalid-property-type-for-collection-format.default` | `"The collectionFormat can only be applied to model property with type 'string[]'."` | - | +| `invalid-property-type-for-collection-format.default` | `"The collectionFormat can only be applied to model property with type 'string[]'."` | "The collectionFormat can only be applied to model property with type 'string[]'." | | `invalid-schema` | `Object` | - | | `invalid-schema.default` | `CallableMessage`<[`"type"`]\> | - | | `missing-path-param` | `Object` | - | | `missing-path-param.default` | `CallableMessage`<[`"param"`]\> | - | | `non-recommended-collection-format` | `Object` | - | -| `non-recommended-collection-format.default` | `"The recommendation of collection format are 'csv' and 'multi'."` | - | +| `non-recommended-collection-format.default` | `"The recommendation of collection format are 'csv' and 'multi'."` | "The recommendation of collection format are 'csv' and 'multi'." | | `nonspecific-scalar` | `Object` | - | | `nonspecific-scalar.default` | `CallableMessage`<[`"type"`, `"chosenType"`]\> | - | | `resource-namespace` | `Object` | - | -| `resource-namespace.default` | `"Resource goes on namespace"` | - | +| `resource-namespace.default` | `"Resource goes on namespace"` | "Resource goes on namespace" | | `security-service-namespace` | `Object` | - | -| `security-service-namespace.default` | `"Cannot add security details to a namespace other than the service namespace."` | - | +| `security-service-namespace.default` | `"Cannot add security details to a namespace other than the service namespace."` | "Cannot add security details to a namespace other than the service namespace." | | `union-null` | `Object` | - | -| `union-null.default` | `"Cannot have a union containing only null types."` | - | +| `union-null.default` | `"Cannot have a union containing only null types."` | "Cannot have a union containing only null types." | | `union-unsupported` | `Object` | - | -| `union-unsupported.default` | `"Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type."` | - | -| `union-unsupported.empty` | `"Empty unions are not supported for OpenAPI v2 - enums must have at least one value."` | - | +| `union-unsupported.default` | `"Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type."` | "Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type." | +| `union-unsupported.empty` | `"Empty unions are not supported for OpenAPI v2 - enums must have at least one value."` | "Empty unions are not supported for OpenAPI v2 - enums must have at least one value." | | `unsupported-auth` | `Object` | - | | `unsupported-auth.default` | `CallableMessage`<[`"authType"`]\> | - | | `unsupported-http-auth-scheme` | `Object` | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/functions/reportDiagnostic.md b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/functions/reportDiagnostic.md index 2da363a4d7..59570aa48d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/functions/reportDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/functions/reportDiagnostic.md @@ -9,7 +9,7 @@ reportDiagnostic(program, diag): void ## Type parameters -| Parameter | +| Type parameter | | :------ | | `C` extends `"invalid-identifier"` \| `"missing-type-parent"` \| `"no-numeric"` \| `"unrecognized-scalar"` | | `M` extends `string` \| `number` \| `symbol` | diff --git a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md index 5d2a691304..f8e0c5e56d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/typespec-service-csharp/reference/js-api/variables/$lib.md @@ -9,7 +9,7 @@ const $lib: TypeSpecLibrary; ## Type declaration -| Member | Type | Description | +| Member | Type | Value | | :------ | :------ | :------ | | `invalid-identifier` | `Object` | - | | `invalid-identifier.default` | `CallableMessage`<[`string`, `string`]\> | - | diff --git a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md index ed2e78860d..685ede3943 100644 --- a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md +++ b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step00.md @@ -2,7 +2,7 @@ ## Installing IDE Tools -If you use Visual Studio or Visual Studio code, the TypeSpec extensions are an important tool in providing a first class experience for writing, editing, and reviewing TypeSpec. See [Installing the VS and VS Code Extensions](https://microsoft.github.io/typespec/introduction/installation#install-the-vs-and-vscode-extensions) for details. +If you use Visual Studio or Visual Studio code, the TypeSpec extensions are an important tool in providing a first class experience for writing, editing, and reviewing TypeSpec. See [Installing the VS and VS Code Extensions](https://typespec.io/docs#install-the-vs-and-vscode-extensions) for details. ## Creating a Service diff --git a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step02.md b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step02.md index 1c612890a2..6429f7dcf6 100644 --- a/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step02.md +++ b/packages/website/versioned_docs/version-latest/getstarted/azure-resource-manager/step02.md @@ -6,7 +6,7 @@ There are three essential components of a resource defined with TypeSpec: - A model type representing the resource, derived from one of the [base resource types](#base-resource-types) - A model type defining the properties of the resource type -- An interface that defines the operations that can be performed on the resource type, usually a combination of [standard resource operations](#standard-resource-operations) and [custom actions](#custom-actions) +- An interface that defines the operations that can be performed on the resource type, usually a combination of [recommended and required Operations](../../howtos/ARM/resource-operations.md#recommended-and-required-operations) and [resource actions](../../howtos/ARM/resource-operations.md#resource-actions-post) > Read the [TypeSpec tutorial](https://github.com/Microsoft/typespec/blob/main/docs/tutorial.md) to learn the basics about TypeSpec model types and interfaces. diff --git a/packages/website/versioned_docs/version-latest/getstarted/installation.md b/packages/website/versioned_docs/version-latest/getstarted/installation.md index 63f9f5b2f1..511f13ec8b 100644 --- a/packages/website/versioned_docs/version-latest/getstarted/installation.md +++ b/packages/website/versioned_docs/version-latest/getstarted/installation.md @@ -9,7 +9,7 @@ You can try TypeSpec on the web without installing anything. ### Installing TypeSpec core toolset -See https://microsoft.github.io/typespec/introduction/installation +See https://typespec.io/docs ## Installing TypeSpec Azure toolsets diff --git a/packages/website/versioned_docs/version-latest/howtos/ARM/resource-type.md b/packages/website/versioned_docs/version-latest/howtos/ARM/resource-type.md index 4c9a04b7bd..998ad29aeb 100644 --- a/packages/website/versioned_docs/version-latest/howtos/ARM/resource-type.md +++ b/packages/website/versioned_docs/version-latest/howtos/ARM/resource-type.md @@ -50,7 +50,7 @@ model EmployeeResource is TrackedResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Tracked Resources [in the DynaTrace sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/dynatrace/main.tsp). +You can find samples of Tracked Resources [in the DynaTrace sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/dynatrace/main.tsp). ### Tenant Resources @@ -75,7 +75,7 @@ model EmployeeResource is ProxyResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Tenant Resources [in the TenantResource sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/tenantResource/main.tsp). +You can find samples of Tenant Resources [in the TenantResource sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/tenantResource/main.tsp). ### Extension Resource @@ -98,7 +98,7 @@ model EmployeeResource is ExtensionResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Extension Resources [in the TenantResource sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/tenantResource/main.tsp). +You can find samples of Extension Resources [in the TenantResource sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/tenantResource/main.tsp). ### Child Resource @@ -123,7 +123,7 @@ model JobResource is ProxyResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Child Resources [in the DynaTrace sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/dynatrace/main.tsp). +You can find samples of Child Resources [in the DynaTrace sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/dynatrace/main.tsp). ### Subscription-based Resource @@ -148,7 +148,7 @@ model EmployeeResource is ProxyResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Subscription Resources [in the OperationTemplates sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/operationsTest/opTemplates.tsp). +You can find samples of Subscription Resources [in the OperationTemplates sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/operationsTest/opTemplates.tsp). ### Location-based Resource @@ -173,7 +173,7 @@ model EmployeeResource is ProxyResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Location Resources [in the OperationTemplates sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/operationsTest/opTemplates.tsp). +You can find samples of Location Resources [in the OperationTemplates sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/operationsTest/opTemplates.tsp). ### Singleton Resource @@ -200,7 +200,7 @@ model EmployeeAgreementResource is ProxyResource { `@visibility(read)`: indicates that this property is returned in the body of responses to operations over this resource, but does not appear in the body of requests. Later sections describe the [usage of property visibility](#property-visibility-and-other-constraints). `@path`: indicates that this property corresponds to the last segment of the url path to the resource (otherwise known as the resource identity). -You can find samples of Singleton Resources [in the DynaTrace sample](https://github.com/Azure/typespec-azure/packages/samples/resource-manager/dynatrace/main.tsp#L120-L128). +You can find samples of Singleton Resources [in the Singleton sample](https://github.com/Azure/typespec-azure/blob/main/packages/samples/specs/resource-manager/arm-scenarios/singleton/main.tsp#L29). ## Designing Resource-specific Properties diff --git a/packages/website/versioned_docs/version-latest/howtos/Azure Core/content-negotiation.md b/packages/website/versioned_docs/version-latest/howtos/Azure Core/content-negotiation.md index d715dabea2..e12472036c 100644 --- a/packages/website/versioned_docs/version-latest/howtos/Azure Core/content-negotiation.md +++ b/packages/website/versioned_docs/version-latest/howtos/Azure Core/content-negotiation.md @@ -1,6 +1,6 @@ # Content Type Negotiation -See [Http documentation on content type negotiation](https://microsoft.github.io/typespec/next/standard-library/http/content-types#content-type-negotiation) for the general concept +See [Http documentation on content type negotiation](https://typespec.io/docs/next/libraries/http/content-types#content-type-negotiation) for the general concept ## Usage with Azure.Core operations diff --git a/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/x-ms-examples.md b/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/x-ms-examples.md new file mode 100644 index 0000000000..8b43a7ad84 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/howtos/migrate-swagger/x-ms-examples.md @@ -0,0 +1,55 @@ +--- +title: x-ms-examples +--- + +The `x-ms-examples` is automatically populated in the generated OpenAPI 2.0 when using the `typespec-autorest` emitter. +The examples must be placed in the `examples-directory` (default to `{project-root}/examples`) and have the `operationdId` property. + +:::warn +Do not use `@extension("x-ms-examples", "")`. +::: + +## Example structure + +Example below assume `example-directory` is `{project-root}/examples`. + +- Single version structure + +``` +main.tsp +examples/ + example1.json + example2.json +``` + +- Multi version structure + +``` +main.tsp +examples/ + 2021-01-01/ + example1.json + example2.json + 2021-01-02/ + example1.json + example2.json +``` + +## Generate the examples + +To generate the examples you can use [oav](https://github.com/Azure/oav). You can run that on the generated openapi.json file. + +Generating basic examples and then manually modify the values. It will generate two examples for each operation: one contains minimal properties set, the other contains the maximal properties set. Since the auto-generated examples consist of random values for most types, you need replace them with meaningful values. + +```bash +oav generate-examples openapi.json +``` + +Note, latest OAV tool should automatically generate the following. However, if you are generating the examples manually, please ensure you have: + +- include `title` field and make sure it is descriptive and unique for each operation. +- include `operationId`. This is used to match with declared operations in TypeSpec and correctly output in swagger. + +:::warn +The examples are now in the examples directory relative to the output openapi.json. You must now copy them to the examples directory in the project root. The typespec-autorest emitter will then copy them back to the correct location when generating the OpenAPI 2.0. +::: diff --git a/packages/website/versioned_docs/version-latest/intro.md b/packages/website/versioned_docs/version-latest/intro.md index 0a2d24113c..5c0f8128f9 100644 --- a/packages/website/versioned_docs/version-latest/intro.md +++ b/packages/website/versioned_docs/version-latest/intro.md @@ -2,7 +2,7 @@ TypeSpec is a language for describing cloud service APIs and generating other API description languages, client and service code, documentation, and other assets. TypeSpec provides highly extensible core language primitives that can describe API shapes common among REST, GraphQL, gRPC, and other protocols. -You can find more information at https://microsoft.github.io/typespec. +You can find more information at https://typespec.io/docs. This site is focused on using TypeSpec in the context of Azure. We have published a set of libraries with standard patterns and templates to make defining Azure management and data-plane services easy and compliant with Azure API guidelines. Using these building blocks and guard rails, your service API will be easier to build, will have an easier time passing API reviews, will be consistent with other Azure diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md index e09bd0aab3..4584478617 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/data-types.md @@ -24,6 +24,14 @@ model Azure.Core.AadOauth2Auth | AuthUrl | The authorization URL. | | TokenUrl | The token URL. | +#### Properties + +| Name | Type | Description | +| ------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------ | +| type | `TypeSpec.Http.AuthType.oauth2` | OAuth2 authentication | +| flows | `[Core.AadTokenAuthFlow]` | Supported OAuth2 flows | +| defaultScopes | `[]` | Oauth2 scopes of every flow. Overridden by scope definitions in specific flows | + ### `AadTokenAuthFlow` {#Azure.Core.AadTokenAuthFlow} Azure Active Directory (AAD) Token Authentication Flow @@ -40,6 +48,15 @@ model Azure.Core.AadTokenAuthFlow | AuthUrl | The authorization URL. | | TokenUrl | The token URL. | +#### Properties + +| Name | Type | Description | +| ---------------- | ------------------------------------------------ | ----------- | +| type | `TypeSpec.Http.OAuth2FlowType.authorizationCode` | | +| authorizationUrl | `AuthUrl` | | +| tokenUrl | `TokenUrl` | | +| scopes | `Scopes` | | + ### `AzureApiKeyAuthentication` {#Azure.Core.AzureApiKeyAuthentication} Azure API Key Authentication using the "Ocp-Apim-Subscription-Key" hea @@ -48,6 +65,14 @@ Azure API Key Authentication using the "Ocp-Apim-Subscription-Key" hea model Azure.Core.AzureApiKeyAuthentication ``` +#### Properties + +| Name | Type | Description | +| ---- | ------------------------------------- | ----------------------- | +| type | `TypeSpec.Http.AuthType.apiKey` | API key authentication | +| in | `TypeSpec.Http.ApiKeyLocation.header` | location of the API key | +| name | `"Ocp-Apim-Subscription-Key"` | name of the API key | + ### `ClientRequestIdHeader` {#Azure.Core.ClientRequestIdHeader} Provides the 'x-ms-client-request-id' header to enable request correlation in requests and responses. @@ -56,6 +81,12 @@ Provides the 'x-ms-client-request-id' header to enable request correlation in re model Azure.Core.ClientRequestIdHeader ``` +#### Properties + +| Name | Type | Description | +| ---------------- | -------------------------- | ------------------------------------------------------------------------------- | +| clientRequestId? | [`uuid`](#Azure.Core.uuid) | An opaque, globally-unique, client-generated string identifier for the request. | + ### `ConditionalRequestHeaders` {#Azure.Core.ConditionalRequestHeaders} Provides the 'If-\*' headers to enable conditional (cached) responses @@ -64,6 +95,15 @@ Provides the 'If-\*' headers to enable conditional (cached) responses model Azure.Core.ConditionalRequestHeaders ``` +#### Properties + +| Name | Type | Description | +| ------------------ | ------------- | ------------------------------------------------------------------------------- | +| ifMatch? | `string` | The request should only proceed if an entity matches this string. | +| ifNoneMatch? | `string` | The request should only proceed if no entity matches this string. | +| ifUnmodifiedSince? | `utcDateTime` | The request should only proceed if the entity was not modified after this time. | +| ifModifiedSince? | `utcDateTime` | The request should only proceed if the entity was modified after this time. | + ### `EmbeddingVector` {#Azure.Core.EmbeddingVector} A vector embedding frequently used in similarity search. @@ -78,6 +118,10 @@ model Azure.Core.EmbeddingVector | ------- | ----------------------------------------- | | Element | The element type of the embedding vector. | +#### Properties + +None + ### `EtagProperty` {#Azure.Core.EtagProperty} Provides the 'ETag' field to enable conditional (cached) requests. This model can be spread @@ -87,6 +131,12 @@ into responses and item models to convey the ETag when it cannot simply conveyed model Azure.Core.EtagProperty ``` +#### Properties + +| Name | Type | Description | +| ---- | -------------------------- | --------------------------------- | +| etag | [`eTag`](#Azure.Core.eTag) | The entity tag for this resource. | + ### `EtagResponseEnvelope` {#Azure.Core.EtagResponseEnvelope} Provides the 'ETag' header to enable conditional (cached) requests @@ -95,6 +145,12 @@ Provides the 'ETag' header to enable conditional (cached) requests model Azure.Core.EtagResponseEnvelope ``` +#### Properties + +| Name | Type | Description | +| ----------- | -------- | -------------------------------- | +| etagHeader? | `string` | The entity tag for the response. | + ### `ExpandQueryParameter` {#Azure.Core.ExpandQueryParameter} Provides the standard 'expand' query parameter for list operations. @@ -103,6 +159,12 @@ Provides the standard 'expand' query parameter for list operations. model Azure.Core.ExpandQueryParameter ``` +#### Properties + +| Name | Type | Description | +| ------- | ---------- | ------------------------------------------------- | +| expand? | `string[]` | Expand the indicated resources into the response. | + ### `FilterParameter` {#Azure.Core.FilterParameter} Provides the standard 'filter' query parameter for list operations @@ -111,6 +173,12 @@ Provides the standard 'filter' query parameter for list operations model Azure.Core.FilterParameter ``` +#### Properties + +| Name | Type | Description | +| ------- | -------- | -------------------------------------------- | +| filter? | `string` | The maximum number of result items per page. | + ### `FilterQueryParameter` {#Azure.Core.FilterQueryParameter} Provides the standard 'filter' query parameter for list operations. @@ -119,6 +187,12 @@ Provides the standard 'filter' query parameter for list operations. model Azure.Core.FilterQueryParameter ``` +#### Properties + +| Name | Type | Description | +| ------- | -------- | -------------------------------------------------- | +| filter? | `string` | Filter the result list using the given expression. | + ### `MaxPageSizeQueryParameter` {#Azure.Core.MaxPageSizeQueryParameter} Provides the standard 'maxpagesize' query parameter for list operations. @@ -127,6 +201,12 @@ Provides the standard 'maxpagesize' query parameter for list operations. model Azure.Core.MaxPageSizeQueryParameter ``` +#### Properties + +| Name | Type | Description | +| ------------ | ------- | -------------------------------------------- | +| maxpagesize? | `int32` | The maximum number of result items per page. | + ### `OrderByQueryParameter` {#Azure.Core.OrderByQueryParameter} Provides the standard 'orderby' query parameter for list operations. @@ -135,6 +215,12 @@ Provides the standard 'orderby' query parameter for list operations. model Azure.Core.OrderByQueryParameter ``` +#### Properties + +| Name | Type | Description | +| -------- | ---------- | ------------------------------------------------------- | +| orderby? | `string[]` | Expressions that specify the order of returned results. | + ### `Page` {#Azure.Core.Page} Describes a page of resource object. @@ -149,6 +235,13 @@ model Azure.Core.Page | -------- | ------------------ | | Resource | The resource type. | +#### Properties + +| Name | Type | Description | +| --------- | -------------------------------- | ----------- | +| value | `Array` | | +| nextLink? | `TypeSpec.Rest.ResourceLocation` | | + ### `PollingOptions` {#Azure.Core.PollingOptions} Generic polling options for LRO operations. @@ -157,6 +250,14 @@ Generic polling options for LRO operations. model Azure.Core.PollingOptions ``` +#### Properties + +| Name | Type | Description | +| ------------- | ------------------------------------------------------------------- | --------------------------------------------------------------- | +| kind | [`PollingOptionKind`](./data-types.md#Azure.Core.PollingOptionKind) | The kind of polling options | +| pollingModel? | `Model \| void` | The model that is returned when polling should continue. | +| finalResult? | `Model \| void` | The type that is returned when polling terminates successfully. | + ### `RepeatabilityRequestHeaders` {#Azure.Core.RepeatabilityRequestHeaders} Provides the 'Repeatability-\*' headers to enable repeatable requests. @@ -165,6 +266,13 @@ Provides the 'Repeatability-\*' headers to enable repeatable requests. model Azure.Core.RepeatabilityRequestHeaders ``` +#### Properties + +| Name | Type | Description | +| ----------------------- | ------------- | ------------------------------------------------------------------------------- | +| repeatabilityRequestId? | `string` | An opaque, globally-unique, client-generated string identifier for the request. | +| repeatabilityFirstSent? | `utcDateTime` | Specifies the date and time at which the request was first created. | + ### `RepeatabilityResponseHeaders` {#Azure.Core.RepeatabilityResponseHeaders} Provides the 'Repeatability-\*' headers to enable repeatable requests. @@ -173,6 +281,12 @@ Provides the 'Repeatability-\*' headers to enable repeatable requests. model Azure.Core.RepeatabilityResponseHeaders ``` +#### Properties + +| Name | Type | Description | +| -------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------ | +| repeatabilityResult? | [`RepeatabilityResult`](./data-types.md#Azure.Core.RepeatabilityResult) | Indicates whether the repeatable request was accepted or rejected. | + ### `RequestIdResponseHeader` {#Azure.Core.RequestIdResponseHeader} Provides the 'x-ms-request-id' header to enable request correlation in responses. @@ -181,6 +295,12 @@ Provides the 'x-ms-request-id' header to enable request correlation in responses model Azure.Core.RequestIdResponseHeader ``` +#### Properties + +| Name | Type | Description | +| ---------- | -------------------------- | ------------------------------------------------------------------------------- | +| requestId? | [`uuid`](#Azure.Core.uuid) | An opaque, globally-unique, server-generated string identifier for the request. | + ### `RequestParameter` {#Azure.Core.RequestParameter} Defines a property as a request parameter. @@ -195,6 +315,10 @@ model Azure.Core.RequestParameter | ---- | ------------------- | | Name | The parameter name. | +#### Properties + +None + ### `ResourceOperationStatus` {#Azure.Core.ResourceOperationStatus} ```typespec @@ -209,6 +333,15 @@ model Azure.Core.ResourceOperationStatus | StatusResult | Model describing the status result object. If not specified, the default is the resource type. | | StatusError | Model describing the status error object. If not specified, the default is the Foundations.Error. | +#### Properties + +| Name | Type | Description | +| ------- | ------------------------------------------------------------------------- | -------------------------------------------------------------- | +| id | `string` | The unique ID of the operation. | +| status | [`OperationState`](./data-types.md#Azure.Core.Foundations.OperationState) | The status of the operation | +| error? | `StatusError` | Error object that describes the error when status is "Failed". | +| result? | `StatusResult` | The result of the operation. | + ### `ResponseProperty` {#Azure.Core.ResponseProperty} Defines a property as a response header. @@ -223,6 +356,10 @@ model Azure.Core.ResponseProperty | ---- | ---------------- | | Name | The header name. | +#### Properties + +None + ### `SelectQueryParameter` {#Azure.Core.SelectQueryParameter} Provides the standard 'select' query parameter for list operations. @@ -231,6 +368,12 @@ Provides the standard 'select' query parameter for list operations. model Azure.Core.SelectQueryParameter ``` +#### Properties + +| Name | Type | Description | +| ------- | ---------- | ----------------------------------------------------------- | +| select? | `string[]` | Select the specified fields to be included in the response. | + ### `SkipQueryParameter` {#Azure.Core.SkipQueryParameter} Provides the standard 'skip' query parameter for list operations. @@ -239,6 +382,12 @@ Provides the standard 'skip' query parameter for list operations. model Azure.Core.SkipQueryParameter ``` +#### Properties + +| Name | Type | Description | +| ----- | ------- | ----------------------------------- | +| skip? | `int32` | The number of result items to skip. | + ### `StandardListQueryParameters` {#Azure.Core.StandardListQueryParameters} Provides the most common query parameters for list operations. @@ -247,6 +396,14 @@ Provides the most common query parameters for list operations. model Azure.Core.StandardListQueryParameters ``` +#### Properties + +| Name | Type | Description | +| ------------ | ------- | -------------------------------------------- | +| top? | `int32` | The number of result items to return. | +| skip? | `int32` | The number of result items to skip. | +| maxpagesize? | `int32` | The maximum number of result items per page. | + ### `StatusMonitorOptions` {#Azure.Core.StatusMonitorOptions} Options for Lro status monitors. @@ -255,6 +412,13 @@ Options for Lro status monitors. model Azure.Core.StatusMonitorOptions ``` +#### Properties + +| Name | Type | Description | +| -------------- | ---------------------------- | --------------------------------------------------------------------------------------- | +| kind | `"statusMonitor"` | The kind of polling options | +| finalProperty? | `ModelProperty \| ErrorType` | A reference to or name of the property of the status monitor that contains the response | + ### `StatusMonitorPollingOptions` {#Azure.Core.StatusMonitorPollingOptions} Options for overriding a polling endpoint that uses a StatusMonitor @@ -271,6 +435,15 @@ model Azure.Core.StatusMonitorPollingOptions | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +None + ### `CreateableAndUpdateableProperties` {#Azure.Core.Foundations.CreateableAndUpdateableProperties} Collection of properties from a resource that are visible to create or update scopes. @@ -406,6 +609,10 @@ model Azure.Core.Foundations.CreateableAndUpdateableProperties | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +None + ### `CustomizationFields` {#Azure.Core.Foundations.CustomizationFields} The expected shape of model types passed to the Custom parameter of operation signatures. @@ -414,6 +621,13 @@ The expected shape of model types passed to the Custom parameter of operation si model Azure.Core.Foundations.CustomizationFields ``` +#### Properties + +| Name | Type | Description | +| ----------- | ---- | ------------------------------------------------------------------------------ | +| parameters? | `{}` | An object containing custom parameters that will be included in the operation. | +| response? | `{}` | An object containing custom properties that will be included in the response. | + ### `CustomPage` {#Azure.Core.Foundations.CustomPage} A model describing a customized page of resources. @@ -429,6 +643,13 @@ model Azure.Core.Foundations.CustomPage | Resource | The type of the resource. | | Traits | Traits which apply to the page. | +#### Properties + +| Name | Type | Description | +| --------- | -------------------------------- | ----------- | +| value | `Array` | | +| nextLink? | `TypeSpec.Rest.ResourceLocation` | | + ### `CustomParameters` {#Azure.Core.Foundations.CustomParameters} A model describing a set of custom request parameters. @@ -443,6 +664,10 @@ model Azure.Core.Foundations.CustomParameters | ------ | ----------------------------------------------- | | Custom | An object describing custom request parameters. | +#### Properties + +None + ### `CustomResponseFields` {#Azure.Core.Foundations.CustomResponseFields} A model describing a set of custom response properties. @@ -457,6 +682,10 @@ model Azure.Core.Foundations.CustomResponseFields | ------ | ------------------------------------------------ | | Custom | An object describing custom response properties. | +#### Properties + +None + ### `Error` {#Azure.Core.Foundations.Error} The error object. @@ -465,6 +694,16 @@ The error object. model Azure.Core.Foundations.Error ``` +#### Properties + +| Name | Type | Description | +| ----------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| code | `string` | One of a server-defined set of error codes. | +| message | `string` | A human-readable representation of the error. | +| target? | `string` | The target of the error. | +| details? | `Core.Foundations.Error[]` | An array of details about specific errors that led to this reported error. | +| innererror? | [`InnerError`](./data-types.md#Azure.Core.Foundations.InnerError) | An object containing more specific information than the current object about the error. | + ### `ErrorResponse` {#Azure.Core.Foundations.ErrorResponse} A response containing error details. @@ -473,6 +712,13 @@ A response containing error details. model Azure.Core.Foundations.ErrorResponse ``` +#### Properties + +| Name | Type | Description | +| ---------- | ------------------------------------------------------- | --------------------------------------------- | +| error | [`Error`](./data-types.md#Azure.Core.Foundations.Error) | The error object. | +| errorCode? | `string` | String error code indicating what went wrong. | + ### `ErrorResponseBase` {#Azure.Core.Foundations.ErrorResponseBase} A response containing error details. @@ -487,6 +733,13 @@ model Azure.Core.Foundations.ErrorResponseBase | ----- | ----------------------------- | | Error | The type of the error object. | +#### Properties + +| Name | Type | Description | +| ---------- | -------- | ----------- | +| error | `Error` | | +| errorCode? | `string` | | + ### `InnerError` {#Azure.Core.Foundations.InnerError} An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. @@ -495,6 +748,13 @@ An object containing more specific information about the error. As per Microsoft model Azure.Core.Foundations.InnerError ``` +#### Properties + +| Name | Type | Description | +| ----------- | ----------------------------------------------------------------- | ------------------------------------------- | +| code? | `string` | One of a server-defined set of error codes. | +| innererror? | [`InnerError`](./data-types.md#Azure.Core.Foundations.InnerError) | Inner error. | + ### `ItemKeysOf` {#Azure.Core.Foundations.ItemKeysOf} A model containing the keys of the provided resource. @@ -509,6 +769,10 @@ model Azure.Core.Foundations.ItemKeysOf | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +None + ### `LocationOfCreatedResourceResponse` {#Azure.Core.Foundations.LocationOfCreatedResourceResponse} Response describing the location of a created resource. @@ -523,6 +787,13 @@ model Azure.Core.Foundations.LocationOfCreatedResourceResponse | -------- | ----------- | | Resource | | +#### Properties + +| Name | Type | Description | +| ---------- | -------------------------------- | ---------------- | +| statusCode | `201` | The status code. | +| location | `TypeSpec.Rest.ResourceLocation` | | + ### `LocationOfCreatedResourceWithServiceProvidedNameResponse` {#Azure.Core.Foundations.LocationOfCreatedResourceWithServiceProvidedNameResponse} Response describing the location of a resource created with a service-provided name. @@ -537,6 +808,13 @@ model Azure.Core.Foundations.LocationOfCreatedResourceWithServiceProvidedNameRes | -------- | ----------- | | Resource | | +#### Properties + +| Name | Type | Description | +| ---------- | -------------------------------- | ---------------- | +| statusCode | `202` | The status code. | +| location | `TypeSpec.Rest.ResourceLocation` | | + ### `LongRunningStatusLocation` {#Azure.Core.Foundations.LongRunningStatusLocation} Metadata for long running operation status monitor locations. @@ -551,6 +829,12 @@ model Azure.Core.Foundations.LongRunningStatusLocation | ------------ | ---------------------------------------- | | StatusResult | The type of the operation status result. | +#### Properties + +| Name | Type | Description | +| ----------------- | -------------------------------- | ----------- | +| operationLocation | `TypeSpec.Rest.ResourceLocation` | | + ### `OperationStatus` {#Azure.Core.Foundations.OperationStatus} Provides status details for long running operations. @@ -566,6 +850,15 @@ model Azure.Core.Foundations.OperationStatus | StatusResult | The type of the operation status result. | | StatusError | The type of the operation status error. If not provided, the default error is used. | +#### Properties + +| Name | Type | Description | +| ------- | ------------------------------------------------------------------------- | ----------- | +| id | `string` | | +| status | [`OperationState`](./data-types.md#Azure.Core.Foundations.OperationState) | | +| error? | `StatusError` | | +| result? | `StatusResult` | | + ### `ResourceBody` {#Azure.Core.Foundations.ResourceBody} Conveys the resource instance to an operation as a request body. @@ -580,6 +873,12 @@ model Azure.Core.Foundations.ResourceBody | -------- | ---------------------------------- | | Resource | The type of the resource instance. | +#### Properties + +| Name | Type | Description | +| -------- | ---------- | ----------- | +| resource | `Resource` | | + ### `ResourceCreateOrReplaceModel` {#Azure.Core.Foundations.ResourceCreateOrReplaceModel} Version of a model for a create or replace operation which only includes updateable properties. @@ -594,6 +893,10 @@ model Azure.Core.Foundations.ResourceCreateOrReplaceModel | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +None + ### `ResourceCreateOrUpdateModel` {#Azure.Core.Foundations.ResourceCreateOrUpdateModel} Version of a model for a create or update operation which only includes updateable properties. @@ -608,6 +911,10 @@ model Azure.Core.Foundations.ResourceCreateOrUpdateModel | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +None + ### `ResourceUpdateModel` {#Azure.Core.Foundations.ResourceUpdateModel} Version of a model for an update operation which only includes updateable properties. @@ -622,6 +929,10 @@ model Azure.Core.Foundations.ResourceUpdateModel | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +None + ### `RetryAfterHeader` {#Azure.Core.Foundations.RetryAfterHeader} The retry-after envelope. @@ -630,6 +941,12 @@ The retry-after envelope. model Azure.Core.Foundations.RetryAfterHeader ``` +#### Properties + +| Name | Type | Description | +| ----------- | ------- | -------------------------------------------------------------------------------------------------------- | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | + ### `OperationState` {#Azure.Core.Foundations.OperationState} Enum describing allowed operation states. @@ -654,6 +971,13 @@ model Azure.Core.Traits.ListQueryParametersTrait | ---------- | --------------------------------------- | | Parameters | Object describing the query parameters. | +#### Properties + +| Name | Type | Description | +| ---------------------- | ------------ | ----------- | +| queryParams | `{...}` | | +| queryParams.parameters | `Parameters` | | + ### `NoClientRequestId` {#Azure.Core.Traits.NoClientRequestId} Indicates that the service or operation does not support clientRequestId headers. @@ -662,6 +986,12 @@ Indicates that the service or operation does not support clientRequestId headers model Azure.Core.Traits.NoClientRequestId ``` +#### Properties + +| Name | Type | Description | +| --------------- | ---- | ----------- | +| clientRequestId | `{}` | | + ### `NoConditionalRequests` {#Azure.Core.Traits.NoConditionalRequests} Indicates that the service or operation does not support conditional requests. @@ -670,6 +1000,12 @@ Indicates that the service or operation does not support conditional requests. model Azure.Core.Traits.NoConditionalRequests ``` +#### Properties + +| Name | Type | Description | +| ------------------- | ---- | ----------- | +| conditionalRequests | `{}` | | + ### `NoRepeatableRequests` {#Azure.Core.Traits.NoRepeatableRequests} Indicates that the service or operation does not support repeatable requests. @@ -678,6 +1014,12 @@ Indicates that the service or operation does not support repeatable requests. model Azure.Core.Traits.NoRepeatableRequests ``` +#### Properties + +| Name | Type | Description | +| ------------------ | ---- | ----------- | +| repeatableRequests | `{}` | | + ### `QueryParametersTrait` {#Azure.Core.Traits.QueryParametersTrait} Declares a trait that is applied as a query parameter. @@ -693,6 +1035,13 @@ model Azure.Core.Traits.QueryParametersTrait | Parameters | The name of the query parameter. | | Contexts | The contexts in which the trait is applicable. | +#### Properties + +| Name | Type | Description | +| ---------------------- | ------------ | ----------- | +| queryParams | `{...}` | | +| queryParams.parameters | `Parameters` | | + ### `RequestHeadersTrait` {#Azure.Core.Traits.RequestHeadersTrait} Declares a trait that is applied as a request header parameter. @@ -708,6 +1057,13 @@ model Azure.Core.Traits.RequestHeadersTrait | Headers | Object describing the request header parameters. | | Contexts | The contexts in which the trait is applicable. | +#### Properties + +| Name | Type | Description | +| ------------------------- | --------- | ----------- | +| requestHeaders | `{...}` | | +| requestHeaders.parameters | `Headers` | | + ### `ResponseHeadersTrait` {#Azure.Core.Traits.ResponseHeadersTrait} Declares a trait that is applied as a response header parameter. @@ -723,6 +1079,13 @@ model Azure.Core.Traits.ResponseHeadersTrait | Headers | Object describing the response header parameters. | | Contexts | The contexts in which the trait is applicable. | +#### Properties + +| Name | Type | Description | +| -------------------------- | --------- | ----------- | +| responseHeaders | `{...}` | | +| responseHeaders.parameters | `Headers` | | + ### `SupportsClientRequestId` {#Azure.Core.Traits.SupportsClientRequestId} Provides clientRequestId headers for requests and responses. @@ -737,6 +1100,14 @@ model Azure.Core.Traits.SupportsClientRequestId | ------------ | ------------------------------------------------------------------------------------------------------------------ | | VersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | +#### Properties + +| Name | Type | Description | +| -------------------------- | --------------------------------------------------------------------------- | ----------- | +| clientRequestId | `{...}` | | +| clientRequestId.parameters | [`ClientRequestIdHeader`](./data-types.md#Azure.Core.ClientRequestIdHeader) | | +| clientRequestId.response | [`ClientRequestIdHeader`](./data-types.md#Azure.Core.ClientRequestIdHeader) | | + ### `SupportsConditionalRequests` {#Azure.Core.Traits.SupportsConditionalRequests} Provides conditional request headers for requests and ETag headers for responses. @@ -751,6 +1122,14 @@ model Azure.Core.Traits.SupportsConditionalRequests | ------------ | ------------------------------------------------------------------------------------------------------------------ | | VersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | +#### Properties + +| Name | Type | Description | +| ------------------------------ | ----------------------------------------------------------------------------------- | ----------- | +| conditionalRequests | `{...}` | | +| conditionalRequests.parameters | [`ConditionalRequestHeaders`](./data-types.md#Azure.Core.ConditionalRequestHeaders) | | +| conditionalRequests.response | [`EtagResponseEnvelope`](./data-types.md#Azure.Core.EtagResponseEnvelope) | | + ### `SupportsRepeatableRequests` {#Azure.Core.Traits.SupportsRepeatableRequests} Provides repeatable request headers for requests and responses. @@ -765,6 +1144,14 @@ model Azure.Core.Traits.SupportsRepeatableRequests | ------------ | ------------------------------------------------------------------------------------------------------------------ | | VersionAdded | The version when the trait was added to the specification.
Leave this empty if the trait is always supported. | +#### Properties + +| Name | Type | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------- | ----------- | +| repeatableRequests | `{...}` | | +| repeatableRequests.parameters | [`RepeatabilityRequestHeaders`](./data-types.md#Azure.Core.RepeatabilityRequestHeaders) | | +| repeatableRequests.response | [`RepeatabilityResponseHeaders`](./data-types.md#Azure.Core.RepeatabilityResponseHeaders) | | + ### `TraitOverride` {#Azure.Core.Traits.TraitOverride} Used to override a trait. @@ -779,6 +1166,10 @@ model Azure.Core.Traits.TraitOverride | ----- | ---------------------- | | Trait | The trait to override. | +#### Properties + +None + ### `VersionParameterTrait` {#Azure.Core.Traits.VersionParameterTrait} Declares a version parameter trait. @@ -793,6 +1184,13 @@ model Azure.Core.Traits.VersionParameterTrait | ---------------- | ---------------------------------- | | VersionParameter | The type of the version parameter. | +#### Properties + +| Name | Type | Description | +| -------------------------------- | ------------------ | ----------- | +| versionParameter | `{...}` | | +| versionParameter.apiVersionParam | `VersionParameter` | | + ### `TraitContext` {#Azure.Core.Traits.TraitContext} Enumerates the standard trait contexts for Azure.Core operations. diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md index 1a5226d6f7..fbefed9ebc 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/decorators.md @@ -22,9 +22,9 @@ Identifies a ModelProperty as containing the final location for the operation re #### Parameters -| Name | Type | Description | -| ----------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| finalResult | `union Model \| void` | Sets the expected return value for the final result. Overrides
any value provided in the decorated property, if the property uses ResourceLocation. | +| Name | Type | Description | +| ----------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| finalResult | `Model \| void` | Sets the expected return value for the final result. Overrides
any value provided in the decorated property, if the property uses ResourceLocation. | ### `@finalOperation` {#@Azure.Core.finalOperation} @@ -43,7 +43,7 @@ Identifies that an operation is the final operation for an LRO. | Name | Type | Description | | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | | linkedOperation | `Operation` | The linked Operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| parameters | `{}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@fixed` {#@Azure.Core.fixed} @@ -89,7 +89,7 @@ Identifies an EnumMember as a long-running "Canceled" terminal state. #### Target -`EnumMember` +`EnumMember | UnionVariant` #### Parameters @@ -124,7 +124,7 @@ Identifies an enum member as a long-running "Failed" terminal state. #### Target -`EnumMember` +`EnumMember | UnionVariant` #### Parameters @@ -160,7 +160,7 @@ status. #### Target -`union Enum | ModelProperty` +`Enum | Union | ModelProperty` #### Parameters @@ -177,7 +177,7 @@ Identifies an EnumMember as a long-running "Succeeded" terminal state. #### Target -`EnumMember` +`EnumMember | UnionVariant` #### Parameters @@ -216,7 +216,7 @@ Identifies that an operation is used to retrieve the next page for paged operati | Name | Type | Description | | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | | linkedOperation | `Operation` | The linked Operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| parameters | `{}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@operationLink` {#@Azure.Core.operationLink} @@ -232,11 +232,11 @@ Identifies an operation that is linked to the target operation. #### Parameters -| Name | Type | Description | -| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| linkedOperation | `Operation` | The linked Operation | -| linkType | `valueof scalar string` | A string indicating the role of the linked operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| Name | Type | Description | +| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------- | +| linkedOperation | `Operation` | The linked Operation | +| linkType | `valueof string` | A string indicating the role of the linked operation | +| parameters | `{}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@pagedResult` {#@Azure.Core.pagedResult} @@ -268,9 +268,9 @@ Identifies a model property as containing the location to poll for operation sta #### Parameters -| Name | Type | Description | -| ------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| options | `model Azure.Core.PollingOptions` | PollingOptions for the poller pointed to by this link. Overrides
settings derived from property value it is decorating, if the value of the
property is ResourceLocation | +| Name | Type | Description | +| ------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| options | [`PollingOptions`](./data-types.md#Azure.Core.PollingOptions) | PollingOptions for the poller pointed to by this link. Overrides
settings derived from property value it is decorating, if the value of the
property is ResourceLocation | ### `@pollingOperation` {#@Azure.Core.pollingOperation} @@ -289,7 +289,7 @@ Identifies that an operation is a polling operation for an LRO. | Name | Type | Description | | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | | linkedOperation | `Operation` | The linked Operation | -| parameters | `model {}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | +| parameters | `{}` | Map of `RequestParameter` and/or `ResponseProperty` that will
be passed to the linked operation request. | ### `@pollingOperationParameter` {#@Azure.Core.pollingOperationParameter} @@ -305,9 +305,9 @@ Used to define how to call custom polling operations for long-running operations #### Parameters -| Name | Type | Description | -| --------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| targetParameter | `union ModelProperty \| string` | A reference to the polling operation parameter this parameter
provides a value for, or the name of that parameter. The default value is the name of
the decorated parameter or property. | +| Name | Type | Description | +| --------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| targetParameter | `ModelProperty \| string` | A reference to the polling operation parameter this parameter
provides a value for, or the name of that parameter. The default value is the name of
the decorated parameter or property. | ## Azure.Core.Foundations @@ -341,9 +341,9 @@ Identifies a property on a request model that serves as a linked operation param #### Parameters -| Name | Type | Description | -| ---- | ----------------------- | --------------------------- | -| name | `valueof scalar string` | Property name on the target | +| Name | Type | Description | +| ---- | ---------------- | --------------------------- | +| name | `valueof string` | Property name on the target | ### `@responseProperty` {#@Azure.Core.Foundations.responseProperty} @@ -359,9 +359,9 @@ Identifies a property on _all_ non-error response models that serve as a linked #### Parameters -| Name | Type | Description | -| ---- | ----------------------- | --------------------------- | -| name | `valueof scalar string` | Property name on the target | +| Name | Type | Description | +| ---- | ---------------- | --------------------------- | +| name | `valueof string` | Property name on the target | ## Azure.Core.Traits @@ -377,13 +377,13 @@ checks. #### Target The model type to mark as a trait. -`(intrinsic) unknown` +`unknown` #### Parameters -| Name | Type | Description | -| --------- | ----------------------- | -------------------------------------------------------------------------------------------------- | -| traitName | `valueof scalar string` | An optional name to uniquely identify the trait. If unspecified,
the model type name is used. | +| Name | Type | Description | +| --------- | ---------------- | -------------------------------------------------------------------------------------------------- | +| traitName | `valueof string` | An optional name to uniquely identify the trait. If unspecified,
the model type name is used. | ### `@traitAdded` {#@Azure.Core.Traits.traitAdded} @@ -396,13 +396,13 @@ to either a trait model type or its envelope property. #### Target -`union Model | ModelProperty` +`Model | ModelProperty` #### Parameters -| Name | Type | Description | -| ------------ | -------------------------- | ------------------------------------------------- | -| addedVersion | `union EnumMember \| null` | The enum member representing the service version. | +| Name | Type | Description | +| ------------ | -------------------- | ------------------------------------------------- | +| addedVersion | `EnumMember \| null` | The enum member representing the service version. | ### `@traitContext` {#@Azure.Core.Traits.traitContext} @@ -419,9 +419,9 @@ The trait envelope property where the context will be applied. #### Parameters -| Name | Type | Description | -| -------- | -------------------------------------- | ------------------------------------------------------------------------------------------ | -| contexts | `union EnumMember \| Union \| unknown` | An enum member or union of enum members representing the trait's
applicable contexts. | +| Name | Type | Description | +| -------- | -------------------------------- | ------------------------------------------------------------------------------------------ | +| contexts | `EnumMember \| Union \| unknown` | An enum member or union of enum members representing the trait's
applicable contexts. | ### `@traitLocation` {#@Azure.Core.Traits.traitLocation} diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md index f163f82fd9..8e615e7167 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/interfaces.md @@ -58,7 +58,7 @@ op Azure.Core.ResourceOperations.LongRunningResourceCreateOrReplace(apiVersion: Create or update operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse +op Azure.Core.ResourceOperations.ResourceCreateOrUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse ``` ##### Template Parameters @@ -73,7 +73,7 @@ op Azure.Core.ResourceOperations.ResourceCreateOrUpdate(apiVersion: string, cont Long-running resource create or update operation template. ```typespec -op Azure.Core.ResourceOperations.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse +op Azure.Core.ResourceOperations.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | (anonymous model) | ErrorResponse ``` ##### Template Parameters @@ -88,7 +88,7 @@ op Azure.Core.ResourceOperations.LongRunningResourceCreateOrUpdate(apiVersion: s Resource update operation template. ```typespec -op Azure.Core.ResourceOperations.ResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | ErrorResponse +op Azure.Core.ResourceOperations.ResourceUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | ErrorResponse ``` ##### Template Parameters @@ -364,7 +364,7 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Long-running operation signature to create or update a resource. ```typespec -op Azure.Core.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.LongRunningResourceCreateOrUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters @@ -502,7 +502,7 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to create or update a resource. ```typespec -op Azure.Core.ResourceCreateOrUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceCreateOrUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters @@ -596,7 +596,7 @@ See https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step05#def Operation signature to update a resource. ```typespec -op Azure.Core.ResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | Azure.Core.Foundations.ErrorResponse +op Azure.Core.ResourceUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | Azure.Core.Foundations.ErrorResponse ``` #### Template Parameters @@ -666,7 +666,7 @@ op Azure.Core.Foundations.LongRunningOperation(apiVersion: string): Azure.Core.F Long-running operation that updates a resource. ```typespec -op Azure.Core.Foundations.LongRunningResourceUpdate(apiVersion: string, contentType: application/merge-patch+json, resource: Resource): (anonymous model) | ErrorResponse +op Azure.Core.Foundations.LongRunningResourceUpdate(apiVersion: string, contentType: "application/merge-patch+json", resource: Resource): (anonymous model) | ErrorResponse ``` #### Template Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md index 0a50d5d4ce..2ed1434151 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/FinalStateValue.md @@ -8,7 +8,7 @@ long-running-operation-options.final-state-via field ## Enumeration Members -| Member | Value | Description | +| Enumeration Member | Value | Description | | :------ | :------ | :------ | | `azureAsyncOperation` | `"azure-async-operation"` | Poll the Azure-AsyncOperation header | | `customLink` | `"custom-link"` | Poll on a header or field other than those above | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md index 981a88f4bd..24b86cb4a2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/enumerations/pollingOptionsKind.md @@ -5,6 +5,6 @@ title: "[E] pollingOptionsKind" --- ## Enumeration Members -| Member | Value | +| Enumeration Member | Value | | :------ | :------ | | `StatusMonitor` | `"statusMonitor"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroCanceled.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroCanceled.md index 9366daf79c..58962adc4f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroCanceled.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroCanceled.md @@ -12,7 +12,7 @@ $lroCanceled(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `EnumMember` | +| `entity` | `EnumMember` \| `UnionVariant` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroFailed.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroFailed.md index 55461d0885..99e344b663 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroFailed.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroFailed.md @@ -12,7 +12,7 @@ $lroFailed(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `EnumMember` | +| `entity` | `EnumMember` \| `UnionVariant` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroStatus.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroStatus.md index df04cbc212..5c489f65a7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroStatus.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroStatus.md @@ -12,7 +12,7 @@ $lroStatus(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` \| `Enum` | +| `entity` | `ModelProperty` \| `Enum` \| `Union` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroSucceeded.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroSucceeded.md index 54e52b7e18..f5c98ce02a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroSucceeded.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/$lroSucceeded.md @@ -12,7 +12,7 @@ $lroSucceeded(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `EnumMember` | +| `entity` | `EnumMember` \| `UnionVariant` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroCanceledState.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroCanceledState.md index 5b44a0e41d..74ca9a7db6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroCanceledState.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroCanceledState.md @@ -14,7 +14,7 @@ Returns `true` if the enum member represents a "canceled" state. | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `EnumMember` | +| `entity` | `EnumMember` \| `UnionVariant` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroFailedState.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroFailedState.md index fdecdb39ce..8abd3abee2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroFailedState.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroFailedState.md @@ -14,7 +14,7 @@ Returns `true` if the enum member represents a "failed" state. | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `EnumMember` | +| `entity` | `EnumMember` \| `UnionVariant` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroSucceededState.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroSucceededState.md index b09349d80e..87bb3208b8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroSucceededState.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/functions/isLroSucceededState.md @@ -14,7 +14,7 @@ Returns `true` if the enum member represents a "succeeded" state. | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `EnumMember` | +| `entity` | `EnumMember` \| `UnionVariant` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/EmbeddingVectorMetadata.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/EmbeddingVectorMetadata.md index 233728d09b..304f4f4d92 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/EmbeddingVectorMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/EmbeddingVectorMetadata.md @@ -5,6 +5,6 @@ title: "[I] EmbeddingVectorMetadata" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `elementType` | `Type` | - | +| Property | Type | +| :------ | :------ | +| `elementType` | `Type` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md index 71d5ee19c0..33fdc46b9f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationLink.md @@ -11,8 +11,8 @@ For long-running operations, the resource link to the final result ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Inherited from | | :------ | :------ | :------ | :------ | | `kind` | `"finalOperationLink"` | - | - | -| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `target` | [`OperationLink`](OperationLink.md) | if a link must be followed to get the result after polling completes, contains information about how to get the uri from the STatusMonitor | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md index c6db688c8c..44be548e96 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/FinalOperationReference.md @@ -11,8 +11,8 @@ For long-running operations, the operation link to the final result ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Inherited from | | :------ | :------ | :------ | :------ | | `kind` | `"finalOperationReference"` | - | - | -| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `target` | [`OperationReference`](OperationReference.md) | if another operation must be called to get the result after polling completes, contains information about how to call this operation | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md index 0ae1de8bf8..c98c1ad4d4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/HttpTerminationStatus.md @@ -7,6 +7,6 @@ Definition of a StatusMonitor that uses http status rather then status code. ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `kind` | `"status-code"` | - | +| Property | Type | +| :------ | :------ | +| `kind` | `"status-code"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md index 6967603988..65267539af 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LogicalOperationStep.md @@ -6,7 +6,7 @@ title: "[I] LogicalOperationStep" Custom polling A step in a logical operation that involves multiple calls -## Extended By +## Extended by - [`PollingOperationStep`](PollingOperationStep.md) - [`NextOperationLink`](NextOperationLink.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LongRunningStates.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LongRunningStates.md index 31b03dbce4..a38255e096 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LongRunningStates.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LongRunningStates.md @@ -8,9 +8,9 @@ Provides the names of terminal long-running operation states plus any ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `canceledState` | `string`[] | - | -| `failedState` | `string`[] | - | -| `states` | `string`[] | - | -| `succeededState` | `string`[] | - | +| Property | Type | +| :------ | :------ | +| `canceledState` | `string`[] | +| `failedState` | `string`[] | +| `states` | `string`[] | +| `succeededState` | `string`[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md index c86ffc387c..ed92630b16 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/LroMetadata.md @@ -20,4 +20,4 @@ For standard Lro Patterns, only the 'logicalResult' and 'finalStateVia' will be | `logicalResult` | `Model` | The model representing important data returned on a success - clients will want to return this model | | `operation` | `Operation` | The operation that was processed | | `pollingInfo` | [`PollingOperationStep`](PollingOperationStep.md) | Specific information about how to process the status monitor, including the location of status, success, and error fields, and the terminal states for polling | -| `statusMonitorStep?` | [`NextOperationLink`](NextOperationLink.md) \| [`NextOperationReference`](NextOperationReference.md) | Specific information on how to reach the StatusMonitor, this is either instructions for constructing a call to the status monitor operation {NextOperationReference} ,
or the response property containing the url that points to the Statue Monitor {NextOperationLink} | +| `statusMonitorStep?` | [`NextOperationLink`](NextOperationLink.md) \| [`NextOperationReference`](NextOperationReference.md) | Specific information on how to reach the StatusMonitor, this is either instructions for constructing a call to the status monitor operation \{NextOperationReference\} ,
or the response property containing the url that points to the Statue Monitor \{NextOperationLink\} | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md index afb1ee4bb6..aae6a24461 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationLink.md @@ -11,8 +11,8 @@ A resource link to the next operation ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Overrides | | :------ | :------ | :------ | :------ | | `kind` | `"nextOperationLink"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `target` | [`OperationLink`](OperationLink.md) | information on how to get the uri to the status monitor | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md index 664a71b4ac..f28850a568 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NextOperationReference.md @@ -11,8 +11,8 @@ An operation link to the next operation ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Overrides | | :------ | :------ | :------ | :------ | | `kind` | `"nextOperationReference"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `target` | [`OperationReference`](OperationReference.md) | Information on how to call the STatusMonitor operation | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md index 936f41a379..423daf8204 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/NoPollingSuccessProperty.md @@ -12,7 +12,7 @@ A step in a logical operation that involves multiple calls ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Overrides | | :------ | :------ | :------ | :------ | | `kind` | `"noPollingResult"` | - | - | -| `responseModel` | `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md index f6df0cbad7..3675780eca 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/OperationLinkMetadata.md @@ -5,11 +5,11 @@ title: "[I] OperationLinkMetadata" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `link?` | [`OperationLink`](OperationLink.md) | - | -| `linkType` | `string` | - | -| `linkedOperation` | `Operation` | - | -| `parameterMap?` | `Map`<`string`, `PropertyMap`\> | - | -| `parameters?` | `Type` | - | -| `result?` | `ResultInfo` | - | +| Property | Type | +| :------ | :------ | +| `link?` | [`OperationLink`](OperationLink.md) | +| `linkType` | `string` | +| `linkedOperation` | `Operation` | +| `parameterMap?` | `Map`<`string`, `PropertyMap`\> | +| `parameters?` | `Type` | +| `result?` | `ResultInfo` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md index 2e89dc7160..b11fef2ff3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingLocationBase.md @@ -5,7 +5,7 @@ title: "[I] PollingLocationBase" --- The abstract type for polling control information -## Extended By +## Extended by - [`StatusMonitorPollingLocationInfo`](StatusMonitorPollingLocationInfo.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md index db8396c6a8..ad0d41a583 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingOperationStep.md @@ -12,10 +12,10 @@ how to end polling ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Overrides | | :------ | :------ | :------ | :------ | | `errorProperty?` | `ModelProperty` | Property of the status monitor that contains operation errors in case of failure (if any) | - | | `kind` | `"pollingOperationStep"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `resultProperty?` | `ModelProperty` | Property of the status monitor that contains the logical operation result (if any) | - | | `terminationStatus` | [`TerminationStatus`](../type-aliases/TerminationStatus.md) | Information on how to determine when the operation reaches a terminal state (most often, this is the terminal values that may be returned in the status field) | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md index 20ba3b18d8..3b88f78269 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessNoResult.md @@ -12,8 +12,8 @@ the operation has no logical final result when polling completes. ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Inherited from | | :------ | :------ | :------ | :------ | | `kind` | `"pollingSuccessNoResult"` | - | - | -| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` \| `IntrinsicType` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `target` | `null` | There is no target | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md index 3efed2f1be..b36a62099b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/PollingSuccessProperty.md @@ -12,9 +12,9 @@ property of the StatusMonitor that contains the success response ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Description | Overrides | | :------ | :------ | :------ | :------ | | `kind` | `"pollingSuccessProperty"` | - | - | -| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep.responseModel`](LogicalOperationStep.md) | +| `responseModel` | `Model` | The TypeSpec type that is returned by following a link or calling a lined operation | [`LogicalOperationStep`](LogicalOperationStep.md).`responseModel` | | `sourceProperty` | `undefined` \| `ModelProperty` | The property in the response that contained a url to the status monitor | - | | `target` | `ModelProperty` | The property containing the results of success | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md index 26df094041..0410874840 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/interfaces/StatusMonitorPollingLocationInfo.md @@ -11,10 +11,10 @@ Collected data for status monitor polling links ## Properties -| Property | Type | Description | Inheritance | -| :------ | :------ | :------ | :------ | -| `finalResult?` | `Model` \| `IntrinsicType` | The type of the final result after polling completes | [`PollingLocationBase.finalResult`](PollingLocationBase.md) | -| `info` | `StatusMonitorMetadata` | The status monitor detailed data for control of polling. | - | -| `kind` | `StatusMonitor` | The kind of status monitor | [`PollingLocationBase.kind`](PollingLocationBase.md) | -| `pollingModel?` | `Model` \| `IntrinsicType` | The type of the poller | [`PollingLocationBase.pollingModel`](PollingLocationBase.md) | -| `target` | `ModelProperty` | The model property containing the polling link | [`PollingLocationBase.target`](PollingLocationBase.md) | +| Property | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | +| `finalResult?` | `Model` \| `IntrinsicType` | The type of the final result after polling completes | [`PollingLocationBase`](PollingLocationBase.md).`finalResult` | [`PollingLocationBase`](PollingLocationBase.md).`finalResult` | +| `info` | `StatusMonitorMetadata` | The status monitor detailed data for control of polling. | - | - | +| `kind` | `StatusMonitor` | The kind of status monitor | [`PollingLocationBase`](PollingLocationBase.md).`kind` | [`PollingLocationBase`](PollingLocationBase.md).`kind` | +| `pollingModel?` | `Model` \| `IntrinsicType` | The type of the poller | [`PollingLocationBase`](PollingLocationBase.md).`pollingModel` | [`PollingLocationBase`](PollingLocationBase.md).`pollingModel` | +| `target` | `ModelProperty` | The model property containing the polling link | [`PollingLocationBase`](PollingLocationBase.md).`target` | [`PollingLocationBase`](PollingLocationBase.md).`target` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md index de9553c8cf..e077b7f255 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/js-api/variables/$lib.md @@ -9,7 +9,7 @@ const $lib: TypeSpecLibrary, never>; ## Type declaration -| Member | Type | Description | +| Member | Type | Value | | :------ | :------ | :------ | | `bad-record-type` | `Object` | - | | `bad-record-type.extendUnknown` | `CallableMessage`<[`string`, `string`, `string`, `string`]\> | - | @@ -19,50 +19,50 @@ const $lib: TypeSpecLibrary, never>; | `conditional-requests-trait-missing` | `Object` | - | | `conditional-requests-trait-missing.default` | `CallableMessage`<[]\> | - | | `expected-success-response` | `Object` | - | -| `expected-success-response.default` | `string` | - | +| `expected-success-response.default` | `string` | "The operation must have a success response" | | `expected-trait-diagnostic-missing` | `Object` | - | | `expected-trait-diagnostic-missing.default` | `string` | - | | `expected-trait-missing` | `Object` | - | | `expected-trait-missing.default` | `CallableMessage`<[`string`, `string`]\> | - | | `invalid-final-operation` | `Object` | - | -| `invalid-final-operation.default` | `string` | - | +| `invalid-final-operation.default` | `string` | "The operation linked in the '@finalOperation' decorator must have a 200 response that includes a model." | | `invalid-parameter` | `Object` | - | | `invalid-parameter.default` | `CallableMessage`<[`string`, `string`]\> | - | | `invalid-resource-type` | `Object` | - | | `invalid-resource-type.missingKey` | `CallableMessage`<[`string`]\> | - | | `invalid-resource-type.missingSegment` | `CallableMessage`<[`string`]\> | - | | `invalid-trait-context` | `Object` | - | -| `invalid-trait-context.default` | `string` | - | +| `invalid-trait-context.default` | `string` | "The trait context can only be an enum member, union of enum members, or \`unknown\`." | | `invalid-trait-property-count` | `Object` | - | | `invalid-trait-property-count.default` | `CallableMessage`<[`string`]\> | - | | `invalid-trait-property-type` | `Object` | - | | `invalid-trait-property-type.default` | `CallableMessage`<[`string`, `string`]\> | - | | `lro-polling-data-missing-from-operation-response` | `Object` | - | -| `lro-polling-data-missing-from-operation-response.default` | `string` | - | +| `lro-polling-data-missing-from-operation-response.default` | `string` | "At least one operation response must contain a field marked with \`@lroStatus\`" | | `lro-status-missing` | `Object` | - | | `lro-status-missing.default` | `CallableMessage`<[`string`]\> | - | | `lro-status-monitor-invalid-result-property` | `Object` | - | | `lro-status-monitor-invalid-result-property.default` | `CallableMessage`<[`string`, `string`]\> | - | | `lro-status-property-invalid-type` | `Object` | - | -| `lro-status-property-invalid-type.default` | `string` | - | +| `lro-status-property-invalid-type.default` | `string` | "Property type must be a union of strings or an enum." | | `lro-status-union-non-string` | `Object` | - | | `lro-status-union-non-string.default` | `CallableMessage`<[`string`]\> | - | | `no-object` | `Object` | - | -| `no-object.default` | `string` | - | +| `no-object.default` | `string` | "Don't use 'object'.\n - If you want an object with any properties, use \`Record\`\n - If you meant anything, use \`unknown\`." | | `operation-link-parameter-invalid` | `Object` | - | -| `operation-link-parameter-invalid.default` | `string` | - | +| `operation-link-parameter-invalid.default` | `string` | "Parameters must be of template type RequestParameter or ResponseProperty." | | `operation-link-parameter-invalid-target` | `Object` | - | | `operation-link-parameter-invalid-target.default` | `CallableMessage`<[`string`]\> | - | | `polling-operation-no-lro-failure` | `Object` | - | -| `polling-operation-no-lro-failure.default` | `string` | - | +| `polling-operation-no-lro-failure.default` | `string` | "The status monitor returned from the polling operation must have a status property, with a known status value the indicates failure. This known value may be named 'Failed' or marked with the '@lroFailed' decorator." | | `polling-operation-no-lro-success` | `Object` | - | -| `polling-operation-no-lro-success.default` | `string` | - | +| `polling-operation-no-lro-success.default` | `string` | "The status monitor returned from the polling operation must have a status property, with a known status value the indicates successful completion. This known value may be named 'Succeeded' or marked with the '@lroSucceeded' decorator." | | `polling-operation-no-ref-or-link` | `Object` | - | -| `polling-operation-no-ref-or-link.default` | `string` | - | +| `polling-operation-no-ref-or-link.default` | `string` | "An operation decorated with '@pollingOperation' must either return a response with an 'Operation-Location' header that will contain a runtime link to the polling operation, or specify parameters and return type properties to map into the polling operation parameters. A map into polling operation parameters can be created using the '@pollingOperationParameter' decorator" | | `polling-operation-no-status-monitor` | `Object` | - | -| `polling-operation-no-status-monitor.default` | `string` | - | +| `polling-operation-no-status-monitor.default` | `string` | "The operation linked in @pollingOperation must return a valid status monitor. The status monitor model must contain a 'status' property, or a property decorated with '@lroStatus'. The status field must be of Enum or Union type and contain terminal status values for success and failure." | | `polling-operation-return-model` | `Object` | - | -| `polling-operation-return-model.default` | `string` | - | +| `polling-operation-return-model.default` | `string` | "An operation annotated with @pollingOperation must return a model or union of model." | | `repeatable-requests-trait-missing` | `Object` | - | | `repeatable-requests-trait-missing.default` | `CallableMessage`<[]\> | - | | `request-parameter-invalid` | `Object` | - | @@ -70,7 +70,7 @@ const $lib: TypeSpecLibrary, never>; | `response-property-invalid` | `Object` | - | | `response-property-invalid.default` | `CallableMessage`<[`string`]\> | - | | `rpc-operation-needs-route` | `Object` | - | -| `rpc-operation-needs-route.default` | `string` | - | +| `rpc-operation-needs-route.default` | `string` | "The operation needs a @route" | | `trait-property-without-location` | `Object` | - | | `trait-property-without-location.default` | `CallableMessage`<[`string`, `string`]\> | - | | `union-enums-circular` | `Object` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/linter.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/linter.md index f735a82fb2..93aa313ef3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/linter.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/reference/linter.md @@ -21,6 +21,7 @@ linter: Available ruleSets: - [`@azure-tools/typespec-azure-core/all`](#@azure-tools/typespec-azure-core/all) +- [`@azure-tools/typespec-azure-core/canonical-versioning`](#@azure-tools/typespec-azure-core/canonical-versioning) ## Rules @@ -28,34 +29,35 @@ Available ruleSets: | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `@azure-tools/typespec-azure-core/operation-missing-api-version` | Operations need an api version parameter. | | `@azure-tools/typespec-azure-core/auth-required` | Enforce service authentication. | -| `@azure-tools/typespec-azure-core/no-operation-id` | Operation ID is automatically generated by the OpenAPI emitters and should not normally be specified. | | `@azure-tools/typespec-azure-core/request-body-problem` | Request body should not be of raw array type. | | `@azure-tools/typespec-azure-core/byos` | Use the BYOS pattern recommended for Azure Services. | | `@azure-tools/typespec-azure-core/casing-style` | Ensure proper casing style. | -| `@azure-tools/typespec-azure-core/spread-discriminated-model` | Check a model with a discriminator has not been used in composition. | | `@azure-tools/typespec-azure-core/composition-over-inheritance` | Check that if a model is used in an operation and has derived models that it has a discriminator or recommend to use composition via spread or `is`. | -| `@azure-tools/typespec-azure-core/prefer-csv-collection-format` | It is recommended to use "csv" for collection format of parameters. | | `@azure-tools/typespec-azure-core/use-extensible-enum` | Enums should be extensible. | | `@azure-tools/typespec-azure-core/known-encoding` | Check for supported encodings. | -| `@azure-tools/typespec-azure-core/use-standard-operations` | Operations should be defined using a signature from the Azure.Core namespace. | +| `@azure-tools/typespec-azure-core/long-running-polling-operation-required` | Long-running operations should have a linked polling operation. | | [`@azure-tools/typespec-azure-core/no-closed-literal-union`](/libraries/azure-core/rules/no-closed-literal-union.md) | Unions of literals should include the base scalar type to mark them as open enum. | | [`@azure-tools/typespec-azure-core/no-enum`](/libraries/azure-core/rules/no-enum.md) | Azure services should not use enums. | | `@azure-tools/typespec-azure-core/no-error-status-codes` | Recommend using the error response defined by Azure REST API guidelines. | +| `@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops` | The @route decorator should not be used on standard resource operation signatures. | | `@azure-tools/typespec-azure-core/no-fixed-enum-discriminator` | Discriminator shouldn't be a fixed enum. | +| [`@azure-tools/typespec-azure-core/non-breaking-versioning`](/libraries/azure-core/rules/non-breaking-versioning.md) | Check that only backward compatible versioning change are done to a service. | | `@azure-tools/typespec-azure-core/no-nullable` | Use `?` for optional properties. | | `@azure-tools/typespec-azure-core/no-offsetdatetime` | Prefer using `utcDateTime` when representing a datetime unless an offset is necessary. | -| `@azure-tools/typespec-azure-core/no-rpc-path-params` | Operations defined using RpcOperation should not have path parameters. | -| `@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops` | The @route decorator should not be used on standard resource operation signatures. | | `@azure-tools/typespec-azure-core/no-response-body` | Ensure that the body is set correctly for the response type. | +| `@azure-tools/typespec-azure-core/no-rpc-path-params` | Operations defined using RpcOperation should not have path parameters. | +| `@azure-tools/typespec-azure-core/no-operation-id` | Operation ID is automatically generated by the OpenAPI emitters and should not normally be specified. | +| `@azure-tools/typespec-azure-core/prefer-csv-collection-format` | It is recommended to use "csv" for collection format of parameters. | | `@azure-tools/typespec-azure-core/no-format` | Azure services should not use the `@format` decorator. | | `@azure-tools/typespec-azure-core/no-multiple-discriminator` | Classes should have at most one discriminator. | | `@azure-tools/typespec-azure-core/no-rest-library-interfaces` | Resource interfaces from the TypeSpec.Rest.Resource library are incompatible with Azure.Core. | | `@azure-tools/typespec-azure-core/no-unknown` | Azure services must not have properties of type `unknown`. | -| `@azure-tools/typespec-azure-core/bad-record-type` | Identify bad record definitions. | -| `@azure-tools/typespec-azure-core/response-schema-problem` | Warn about operations having multiple non-error response schemas. | | `@azure-tools/typespec-azure-core/property-name-conflict` | Avoid naming conflicts. | -| `@azure-tools/typespec-azure-core/rpc-operation-request-body` | Warning for RPC body problems. | +| `@azure-tools/typespec-azure-core/bad-record-type` | Identify bad record definitions. | | `@azure-tools/typespec-azure-core/documentation-required` | Require documentation over enums, models, and operations. | | `@azure-tools/typespec-azure-core/key-visibility-required` | Key properties need to have an explicit visibility setting. | -| `@azure-tools/typespec-azure-core/long-running-polling-operation-required` | Long-running operations should have a linked polling operation. | +| `@azure-tools/typespec-azure-core/response-schema-problem` | Warn about operations having multiple non-error response schemas. | +| `@azure-tools/typespec-azure-core/rpc-operation-request-body` | Warning for RPC body problems. | +| `@azure-tools/typespec-azure-core/spread-discriminated-model` | Check a model with a discriminator has not been used in composition. | | `@azure-tools/typespec-azure-core/use-standard-names` | Use recommended names for operations. | +| `@azure-tools/typespec-azure-core/use-standard-operations` | Operations should be defined using a signature from the Azure.Core namespace. | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/no-enum.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/no-enum.md index 85937edeaa..163be2cf76 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/no-enum.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/no-enum.md @@ -27,3 +27,12 @@ union PetKind { string, } ``` + +Ok. Enum is allowed for versioning purposes. + +```tsp +enum Version { + 2021_01_01: "2021-01-01", + 2022_01_01: "2022-01-01", +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/non-breaking-versioning.md b/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/non-breaking-versioning.md new file mode 100644 index 0000000000..c7861b7d99 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-core/rules/non-breaking-versioning.md @@ -0,0 +1,72 @@ +--- +title: "non-breaking-versioning" +--- + +```text title="Full name" +@azure-tools/typespec-azure-core/non-breaking-versioning +``` + +Verify that only backward compatible changes are made to the API. + +#### ❌ Incorrect + +- Removed + +```tsp +model Foo { + @removed(Versions.v2024_01_01) + bar: string; +} +``` + +- Renamed + +```tsp +model Foo { + @renamedFrom(Versions.v2024_01_01, "baz") + bar: string; +} +``` + +- Added required property + +```tsp +model Foo { + @added(Versions.v2024_01_01) + bar: string; +} +``` + +- Made optional without default + +```tsp +model Foo { + @madeOptional(Versions.v2024_01_01) + bar: string; +} +``` + +#### ✅ Correct + +- Adding new type + +```tsp +@added(Versions.v2024_01_01) +model Foo {} +``` + +- Adding operation + +```tsp +@added(Versions.v2024_01_01) +op foo(): Foo; +``` + +- Adding optional property + +```tsp +model Foo { + @added(Versions.v2024_01_01) + bar?: string; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/data-types.md new file mode 100644 index 0000000000..04c8b49efe --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/data-types.md @@ -0,0 +1,113 @@ +--- +title: "Data types" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Data types + +## Azure.Portal + +### `AboutOptions` {#Azure.Portal.AboutOptions} + +Options for about of ARM resource. + +```typespec +model Azure.Portal.AboutOptions +``` + +#### Properties + +| Name | Type | Description | +| -------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| icon? | [`FilePath`](./data-types.md#Azure.Portal.FilePath) | Icon which represent resource | +| displayNames? | [`DisplayNamesOptions`](./data-types.md#Azure.Portal.DisplayNamesOptions) | Display names which represent the resource | +| keywords? | `string[]` | Comma-separated set of words or phrases which allow users to search for your asset by identifiers. | +| learnMoreDocs? | `Portal.LearnMoreDocsOptions[]` | Set of links which can help learn more about the resource | + +### `BrowseOptions` {#Azure.Portal.BrowseOptions} + +Options for browse of ARM resource. + +```typespec +model Azure.Portal.BrowseOptions +``` + +#### Properties + +| Name | Type | Description | +| --------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| argQuery? | `string \| Portal.FilePath` | argQuery can be a literal string query or KQL file path.
KQL query which represents all possible data for your desired browse view. | + +### `DisplayNamesOptions` {#Azure.Portal.DisplayNamesOptions} + +Options for displayNames of ARM resources. + +```typespec +model Azure.Portal.DisplayNamesOptions +``` + +#### Properties + +| Name | Type | Description | +| -------- | -------- | ----------- | +| singular | `string` | | +| plural | `string` | | + +### `FilePath` {#Azure.Portal.FilePath} + +File path of a file + +```typespec +model Azure.Portal.FilePath +``` + +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------- | +| filePath | `string` | File path of a file | + +### `LearnMoreDocsOptions` {#Azure.Portal.LearnMoreDocsOptions} + +Options for learnMoreDocs of ARM resources. + +```typespec +model Azure.Portal.LearnMoreDocsOptions +``` + +#### Properties + +| Name | Type | Description | +| ----- | -------- | ----------- | +| title | `string` | | +| uri | `string` | | + +### `MarketplaceOfferOptions` {#Azure.Portal.MarketplaceOfferOptions} + +Options for marketplaceOffer + +```typespec +model Azure.Portal.MarketplaceOfferOptions +``` + +#### Properties + +| Name | Type | Description | +| ---- | -------- | ---------------------------------- | +| id? | `string` | Marketplace offer id of a resource | + +### `PromotionOptions` {#Azure.Portal.PromotionOptions} + +Options for promotion of ARM resource. + +```typespec +model Azure.Portal.PromotionOptions +``` + +#### Properties + +| Name | Type | Description | +| ----------- | ---------------------- | ----------- | +| apiVersion | `string \| EnumMember` | | +| autoUpdate? | `boolean` | | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/decorators.md new file mode 100644 index 0000000000..901f6a2eb9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/decorators.md @@ -0,0 +1,100 @@ +--- +title: "Decorators" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Decorators + +## Azure.Portal + +### `@about` {#@Azure.Portal.about} + +Provides a Model describing about of ARM resource. + +```typespec +@Azure.Portal.about(options: Azure.Portal.AboutOptions) +``` + +#### Target + +`Model` + +#### Parameters + +| Name | Type | Description | +| ------- | ----------------------------------------------------------- | ------------------------------------------------------------------------ | +| options | [`AboutOptions`](./data-types.md#Azure.Portal.AboutOptions) | Property options allows more detailed infomation about the resourceType. | + +### `@browse` {#@Azure.Portal.browse} + +Provides a Model customizing browse view of ARM resource. + +```typespec +@Azure.Portal.browse(options: Azure.Portal.BrowseOptions) +``` + +#### Target + +`Model` + +#### Parameters + +| Name | Type | Description | +| ------- | ------------------------------------------------------------- | ------------------------------------------------------------------- | +| options | [`BrowseOptions`](./data-types.md#Azure.Portal.BrowseOptions) | Property options provides browsing information of the resourceType. | + +### `@displayName` {#@Azure.Portal.displayName} + +Provides a Model Property a display name + +```typespec +@Azure.Portal.displayName(name: valueof string) +``` + +#### Target + +`ModelProperty` + +#### Parameters + +| Name | Type | Description | +| ---- | ---------------- | ----------- | +| name | `valueof string` | | + +### `@marketplaceOffer` {#@Azure.Portal.marketplaceOffer} + +Provides a Model marketplace offer information of ARM resource. + +```typespec +@Azure.Portal.marketplaceOffer(options: Azure.Portal.MarketplaceOfferOptions) +``` + +#### Target + +`Model` + +#### Parameters + +| Name | Type | Description | +| ------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| options | [`MarketplaceOfferOptions`](./data-types.md#Azure.Portal.MarketplaceOfferOptions) | Property options provides marketplace offer information of the resourceType. | + +### `@promotion` {#@Azure.Portal.promotion} + +Provides a Model customizing deployment promotion apiVersion for ARM resource. +The apiVersion will be used as a version to deploy to Portal. + +```typespec +@Azure.Portal.promotion(options: Azure.Portal.PromotionOptions) +``` + +#### Target + +`Model` + +#### Parameters + +| Name | Type | Description | +| ------- | ------------------------------------------------------------------- | -------------------------------------------------------------------- | +| options | [`PromotionOptions`](./data-types.md#Azure.Portal.PromotionOptions) | Property options provides promotion information of the resourceType. | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/index.mdx new file mode 100644 index 0000000000..c1fedc0fe4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/index.mdx @@ -0,0 +1,54 @@ +--- +title: Overview +sidebar_position: 0 +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Overview + +TypeSpec Azure Portal Core library + +## Install + + + + +```bash +npm install @azure-tools/typespec-azure-portal-core +``` + + + + +```bash +npm install --save-peer @azure-tools/typespec-azure-portal-core +``` + + + + +## Azure + +## Azure.Portal + +### Decorators + +- [`@about`](./decorators.md#@Azure.Portal.about) +- [`@browse`](./decorators.md#@Azure.Portal.browse) +- [`@displayName`](./decorators.md#@Azure.Portal.displayName) +- [`@marketplaceOffer`](./decorators.md#@Azure.Portal.marketplaceOffer) +- [`@promotion`](./decorators.md#@Azure.Portal.promotion) + +### Models + +- [`AboutOptions`](./data-types.md#Azure.Portal.AboutOptions) +- [`BrowseOptions`](./data-types.md#Azure.Portal.BrowseOptions) +- [`DisplayNamesOptions`](./data-types.md#Azure.Portal.DisplayNamesOptions) +- [`FilePath`](./data-types.md#Azure.Portal.FilePath) +- [`LearnMoreDocsOptions`](./data-types.md#Azure.Portal.LearnMoreDocsOptions) +- [`MarketplaceOfferOptions`](./data-types.md#Azure.Portal.MarketplaceOfferOptions) +- [`PromotionOptions`](./data-types.md#Azure.Portal.PromotionOptions) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/_category_.json b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/_category_.json new file mode 100644 index 0000000000..bc91d15cee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/_category_.json @@ -0,0 +1 @@ +{"label":"JS API","link":{"type":"doc","id":"index"}} \ No newline at end of file diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$about.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$about.md new file mode 100644 index 0000000000..308075b720 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$about.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $about" + +--- +```ts +$about( + context, + target, + options): void +``` + +This is a About decorator that will be used to define icon, keywords and learnMoreDocs. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | - | +| `target` | `Model` | The model that is being decorated. | +| `options` | `Model` | AboutOptions of the property. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$browse.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$browse.md new file mode 100644 index 0000000000..7f9b07bfe1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$browse.md @@ -0,0 +1,25 @@ +--- +jsApi: true +title: "[F] $browse" + +--- +```ts +$browse( + context, + target, + options): void +``` + +This is a Browse decorator which will be use to put more info on the browse view. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `context` | `DecoratorContext` | - | +| `target` | `Model` | The model that is being decorated. | +| `options` | `Model` | BrowseOptions of the property. | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$displayName.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$displayName.md new file mode 100644 index 0000000000..eadca91a33 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$displayName.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $displayName" + +--- +```ts +$displayName( + context, + target, + name): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `ModelProperty` | +| `name` | `string` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$marketplaceOffer.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$marketplaceOffer.md new file mode 100644 index 0000000000..eee09357a0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$marketplaceOffer.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $marketplaceOffer" + +--- +```ts +$marketplaceOffer( + context, + target, + options): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` | +| `options` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$onValidate.md new file mode 100644 index 0000000000..6b74d2f3fb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$onValidate.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] $onValidate" + +--- +```ts +$onValidate(program): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | + +## Returns + +`Promise`<`void`\> diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$promotion.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$promotion.md new file mode 100644 index 0000000000..ee9ad32ee4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/$promotion.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] $promotion" + +--- +```ts +$promotion( + context, + target, + options): void +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `DecoratorContext` | +| `target` | `Model` | +| `options` | `Model` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsArmResource.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsArmResource.md new file mode 100644 index 0000000000..21028d8f0f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsArmResource.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] checkIsArmResource" + +--- +```ts +checkIsArmResource( + program, + target, + decoratorName): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Model` | +| `decoratorName` | `"browse"` \| `"about"` \| `"marketplaceOffer"` \| `"promotion"` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsValidApiVersion.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsValidApiVersion.md new file mode 100644 index 0000000000..75a582bf8b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/checkIsValidApiVersion.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] checkIsValidApiVersion" + +--- +```ts +checkIsValidApiVersion( + program, + target, + version): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Model` | +| `version` | `string` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAbout.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAbout.md new file mode 100644 index 0000000000..854c8d3b02 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAbout.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAbout" + +--- +```ts +getAbout(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutDisplayNames.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutDisplayNames.md new file mode 100644 index 0000000000..bfdd5c2478 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutDisplayNames.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAboutDisplayNames" + +--- +```ts +getAboutDisplayNames(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutKeywords.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutKeywords.md new file mode 100644 index 0000000000..79c6030b92 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutKeywords.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAboutKeywords" + +--- +```ts +getAboutKeywords(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutLearnMoreDocs.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutLearnMoreDocs.md new file mode 100644 index 0000000000..900445f1b5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getAboutLearnMoreDocs.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAboutLearnMoreDocs" + +--- +```ts +getAboutLearnMoreDocs(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowse.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowse.md new file mode 100644 index 0000000000..45ed514b92 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowse.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getBrowse" + +--- +```ts +getBrowse(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowseArgQuery.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowseArgQuery.md new file mode 100644 index 0000000000..0223d64f63 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getBrowseArgQuery.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getBrowseArgQuery" + +--- +```ts +getBrowseArgQuery(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getDisplayName.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getDisplayName.md new file mode 100644 index 0000000000..08c53568d8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getDisplayName.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getDisplayName" + +--- +```ts +getDisplayName(program, target): string | undefined +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getMarketplaceOfferId.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getMarketplaceOfferId.md new file mode 100644 index 0000000000..43e1a22810 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getMarketplaceOfferId.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getMarketplaceOfferId" + +--- +```ts +getMarketplaceOfferId(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getPromotion.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getPromotion.md new file mode 100644 index 0000000000..1d1531ca48 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/getPromotion.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getPromotion" + +--- +```ts +getPromotion(program, target): any +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `program` | `Program` | +| `target` | `Type` | + +## Returns + +`any` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/isFileExist.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/isFileExist.md new file mode 100644 index 0000000000..6c115dfd03 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/functions/isFileExist.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isFileExist" + +--- +```ts +isFileExist(host, filePath): Promise +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `host` | `CompilerHost` | +| `filePath` | `string` | + +## Returns + +`Promise`<`boolean`\> diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md new file mode 100644 index 0000000000..3a87908640 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/index.md @@ -0,0 +1,41 @@ +--- +jsApi: true +title: "[P] JS API" + +--- +## Interfaces + +- [AboutOptions](interfaces/AboutOptions.md) +- [BrowseOptions](interfaces/BrowseOptions.md) +- [DisplayNamesOptions](interfaces/DisplayNamesOptions.md) +- [FilePath](interfaces/FilePath.md) +- [LearnMoreDocsOptions](interfaces/LearnMoreDocsOptions.md) +- [MarketplaceOfferOptions](interfaces/MarketplaceOfferOptions.md) +- [PromotionOptions](interfaces/PromotionOptions.md) + +## Variables + +- [$lib](variables/$lib.md) +- [PortalCoreKeys](variables/PortalCoreKeys.md) +- [namespace](variables/namespace.md) + +## Functions + +- [$about](functions/$about.md) +- [$browse](functions/$browse.md) +- [$displayName](functions/$displayName.md) +- [$marketplaceOffer](functions/$marketplaceOffer.md) +- [$onValidate](functions/$onValidate.md) +- [$promotion](functions/$promotion.md) +- [checkIsArmResource](functions/checkIsArmResource.md) +- [checkIsValidApiVersion](functions/checkIsValidApiVersion.md) +- [getAbout](functions/getAbout.md) +- [getAboutDisplayNames](functions/getAboutDisplayNames.md) +- [getAboutKeywords](functions/getAboutKeywords.md) +- [getAboutLearnMoreDocs](functions/getAboutLearnMoreDocs.md) +- [getBrowse](functions/getBrowse.md) +- [getBrowseArgQuery](functions/getBrowseArgQuery.md) +- [getDisplayName](functions/getDisplayName.md) +- [getMarketplaceOfferId](functions/getMarketplaceOfferId.md) +- [getPromotion](functions/getPromotion.md) +- [isFileExist](functions/isFileExist.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/AboutOptions.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/AboutOptions.md new file mode 100644 index 0000000000..8d9bca8628 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/AboutOptions.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[I] AboutOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `description?` | `string` | +| `displayNames?` | [`DisplayNamesOptions`](DisplayNamesOptions.md) | +| `icon?` | [`FilePath`](FilePath.md) | +| `keywords?` | `string`[] | +| `learnMoreDocs?` | [`LearnMoreDocsOptions`](LearnMoreDocsOptions.md)[] | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/BrowseOptions.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/BrowseOptions.md new file mode 100644 index 0000000000..e449d88fc2 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/BrowseOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] BrowseOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `argQuery?` | `string` \| [`FilePath`](FilePath.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/DisplayNamesOptions.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/DisplayNamesOptions.md new file mode 100644 index 0000000000..25b5356ed9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/DisplayNamesOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] DisplayNamesOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `plural` | `string` | +| `singular` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/FilePath.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/FilePath.md new file mode 100644 index 0000000000..ef15f1ce6c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/FilePath.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] FilePath" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `filePath` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/LearnMoreDocsOptions.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/LearnMoreDocsOptions.md new file mode 100644 index 0000000000..85ca7db4f4 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/LearnMoreDocsOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] LearnMoreDocsOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `title` | `string` | +| `uri` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/MarketplaceOfferOptions.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/MarketplaceOfferOptions.md new file mode 100644 index 0000000000..f775e9a41f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/MarketplaceOfferOptions.md @@ -0,0 +1,10 @@ +--- +jsApi: true +title: "[I] MarketplaceOfferOptions" + +--- +## Properties + +| Property | Type | +| :------ | :------ | +| `id?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/PromotionOptions.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/PromotionOptions.md new file mode 100644 index 0000000000..dd2a35a0e1 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/interfaces/PromotionOptions.md @@ -0,0 +1,11 @@ +--- +jsApi: true +title: "[I] PromotionOptions" + +--- +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `apiVersion` | `readonly` | `string` \| `EnumMember` | +| `autoUpdate?` | `readonly` | `boolean` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..c95db031f0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/$lib.md @@ -0,0 +1,32 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary, + | "browse" + | "about" + | "marketplaceOffer" + | "displayName" +| "promotion">; +``` + +## Type declaration + +| Member | Type | Value | +| :------ | :------ | :------ | +| `file-not-found` | `Object` | - | +| `file-not-found.default` | `CallableMessage`<[`string`, `string`, `string`]\> | - | +| `invalid-apiversion` | `Object` | - | +| `invalid-apiversion.promotionVersion` | `CallableMessage`<[`string`]\> | - | +| `invalid-apiversion.serviceVersion` | `CallableMessage`<[`string`]\> | - | +| `invalid-apiversion.versionsList` | `CallableMessage`<[`string`]\> | - | +| `invalid-link` | `Object` | - | +| `invalid-link.default` | `CallableMessage`<[`string`]\> | - | +| `invalid-offer-id` | `Object` | - | +| `invalid-offer-id.marketplaceOfferId` | `"@marketplaceOffer id cannot have a blank space."` | - | +| `not-a-resource` | `Object` | - | +| `not-a-resource.default` | `CallableMessage`<[`string`]\> | - | +| `too-many-essentials` | `Object` | - | +| `too-many-essentials.default` | `"essentials can be only used 5 times in ModelProperty."` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/PortalCoreKeys.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/PortalCoreKeys.md new file mode 100644 index 0000000000..7504e93cbd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/PortalCoreKeys.md @@ -0,0 +1,13 @@ +--- +jsApi: true +title: "[V] PortalCoreKeys" + +--- +```ts +PortalCoreKeys: Record< + | "browse" + | "about" + | "marketplaceOffer" + | "displayName" +| "promotion", symbol>; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/namespace.md b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/namespace.md new file mode 100644 index 0000000000..de6337c962 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-portal-core/reference/js-api/variables/namespace.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] namespace" + +--- +```ts +const namespace: "Azure.Portal" = "Azure.Portal"; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md index 257d41dfb0..eaec3f4538 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/data-types.md @@ -16,6 +16,12 @@ The default api-version parameter type. model Azure.ResourceManager.ApiVersionParameter ``` +#### Properties + +| Name | Type | Description | +| ---------- | -------- | ------------------------------------------ | +| apiVersion | `string` | The API version to use for this operation. | + ### `ArmAcceptedLroResponse` {#Azure.ResourceManager.ArmAcceptedLroResponse} ```typespec @@ -29,6 +35,13 @@ model Azure.ResourceManager.ArmAcceptedLroResponse | Description | The description of the response status (defaults to `Resource operation accepted`) | | LroHeaders | Optional. The lro headers that appear in the Accepted response | +#### Properties + +| Name | Type | Description | +| ----------- | ------- | -------------------------------------------------------------------------------------------------------- | +| statusCode | `202` | The status code. | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | + ### `ArmAcceptedResponse` {#Azure.ResourceManager.ArmAcceptedResponse} ```typespec @@ -41,6 +54,13 @@ model Azure.ResourceManager.ArmAcceptedResponse | ------- | ---------------------------------------------------------------------------------- | | Message | The description of the response status (defaults to `Resource operation accepted`) | +#### Properties + +| Name | Type | Description | +| ----------- | ------- | -------------------------------------------------------------------------------------------------------- | +| statusCode | `202` | The status code. | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | + ### `ArmAsyncOperationHeader` {#Azure.ResourceManager.ArmAsyncOperationHeader} The standard header for asynchronous operation polling @@ -56,6 +76,12 @@ model Azure.ResourceManager.ArmAsyncOperationHeader | StatusMonitor | The status monitor type for lro polling | | UrlValue | The value type of the Azure-AsyncOperation header | +#### Properties + +| Name | Type | Description | +| -------------------- | ---------- | ---------------------------- | +| azureAsyncOperation? | `UrlValue` | A link to the status monitor | + ### `ArmCombinedLroHeaders` {#Azure.ResourceManager.ArmCombinedLroHeaders} Provide Both Azure-AsyncOperation and Location headers @@ -73,6 +99,13 @@ model Azure.ResourceManager.ArmCombinedLroHeaders | ------------ | --------------------------------- | | ResponseBody | The contents of the response body | +#### Properties + +| Name | Type | Description | +| ----------- | -------------- | -------------------------------------------------------------------------------------------------------- | +| statusCode | `201` | The status code. | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | +| body | `ResponseBody` | The body type of the operation request or response. | + ### `ArmDeleteAcceptedLroResponse` {#Azure.ResourceManager.ArmDeleteAcceptedLroResponse} ```typespec @@ -99,18 +140,38 @@ model Azure.ResourceManager.ArmDeleteAcceptedLroResponse | ---------- | --------------------------------------------------------------------- | | LroHeaders | Optional. Allows overriding the Lro headers returned in the response. | +#### Properties + +| Name | Type | Description | +| ----------- | ------- | -------------------------------------------------------------------------------------------------------- | +| statusCode | `202` | The status code. | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | + ### `ArmDeleteAcceptedResponse` {#Azure.ResourceManager.ArmDeleteAcceptedResponse} ```typespec model Azure.ResourceManager.ArmDeleteAcceptedResponse ``` +#### Properties + +| Name | Type | Description | +| ----------- | ------- | -------------------------------------------------------------------------------------------------------- | +| statusCode | `202` | The status code. | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | + ### `ArmDeletedNoContentResponse` {#Azure.ResourceManager.ArmDeletedNoContentResponse} ```typespec model Azure.ResourceManager.ArmDeletedNoContentResponse ``` +#### Properties + +| Name | Type | Description | +| ---------- | ----- | ---------------- | +| statusCode | `204` | The status code. | + ### `ArmDeletedResponse` {#Azure.ResourceManager.ArmDeletedResponse} The response for synchronous delete of a resource @@ -119,6 +180,12 @@ The response for synchronous delete of a resource model Azure.ResourceManager.ArmDeletedResponse ``` +#### Properties + +| Name | Type | Description | +| ---------- | ----- | ---------------- | +| statusCode | `200` | The status code. | + ### `ArmLocationResource` {#Azure.ResourceManager.ArmLocationResource} Template for ARM location resources. Use the parameter to specify @@ -133,6 +200,12 @@ model Azure.ResourceManager.ArmLocationResource | -------- | ----------- | | BaseType | | +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------ | +| location | `string` | The location name. | + ### `ArmLroLocationHeader` {#Azure.ResourceManager.ArmLroLocationHeader} The default header for lro PUT and DELETE polling @@ -149,6 +222,12 @@ model Azure.ResourceManager.ArmLroLocationHeader | ------- | --------------------------------------------------------------------------------------- | | Message | The description of the response status (defaults to `Operation completed successfully`) | +#### Properties + +| Name | Type | Description | +| ---------- | ----- | ---------------- | +| statusCode | `204` | The status code. | + ### `ArmOperationStatus` {#Azure.ResourceManager.ArmOperationStatus} Standard Azure Resource Manager operation status response @@ -178,6 +263,19 @@ model Azure.ResourceManager.ArmOperationStatus | Properties | Optional resource-specific properties | | StatusValues | The set of allowed values for operation status | +#### Properties + +| Name | Type | Description | +| ---------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | +| properties? | `Properties` | RP-specific properties for the operationStatus resource, only appears when operation ended with Succeeded status | +| status | `StatusValues` | The operation status | +| id | `Core.uuid` | The unique identifier for the operationStatus resource | +| name? | `string` | The name of the operationStatus resource | +| startTime? | `utcDateTime` | Operation start time | +| endTime? | `utcDateTime` | Operation complete time | +| percentComplete? | `float64` | The progress made toward completing the operation | +| error? | [`ErrorDetail`](./data-types.md#Azure.ResourceManager.Foundations.ErrorDetail) | Errors that occurred if the operation ended with Canceled or Failed status | + ### `ArmResourceCreatedResponse` {#Azure.ResourceManager.ArmResourceCreatedResponse} ```typespec @@ -191,6 +289,14 @@ model Azure.ResourceManager.ArmResourceCreatedResponse | Resource | The resource being updated | | LroHeaders | Optional. The lro headers returned with a Created response | +#### Properties + +| Name | Type | Description | +| ----------- | ---------- | -------------------------------------------------------------------------------------------------------- | +| statusCode | `201` | The status code. | +| retryAfter? | `int32` | The Retry-After header can indicate how long the client should wait before polling the operation status. | +| body | `Resource` | | + ### `ArmResourceCreatedSyncResponse` {#Azure.ResourceManager.ArmResourceCreatedSyncResponse} ```typespec @@ -203,6 +309,37 @@ model Azure.ResourceManager.ArmResourceCreatedSyncResponse | -------- | -------------------------- | | Resource | The resource being updated | +#### Properties + +| Name | Type | Description | +| ---------- | ---------- | --------------------------------------------------- | +| body | `Resource` | The body type of the operation request or response. | +| statusCode | `201` | The status code. | + +### `ArmResourceExistsResponse` {#Azure.ResourceManager.ArmResourceExistsResponse} + +```typespec +model Azure.ResourceManager.ArmResourceExistsResponse +``` + +#### Properties + +| Name | Type | Description | +| ---------- | ----- | ---------------- | +| statusCode | `204` | The status code. | + +### `ArmResourceNotFoundResponse` {#Azure.ResourceManager.ArmResourceNotFoundResponse} + +```typespec +model Azure.ResourceManager.ArmResourceNotFoundResponse +``` + +#### Properties + +| Name | Type | Description | +| ---------- | ----- | ---------------- | +| statusCode | `404` | The status code. | + ### `ArmResourceUpdatedResponse` {#Azure.ResourceManager.ArmResourceUpdatedResponse} ```typespec @@ -215,6 +352,13 @@ model Azure.ResourceManager.ArmResourceUpdatedResponse | -------- | -------------------------- | | Resource | The resource being updated | +#### Properties + +| Name | Type | Description | +| ---------- | ---------- | --------------------------------------------------- | +| statusCode | `200` | The status code. | +| body | `Resource` | The body type of the operation request or response. | + ### `ArmResponse` {#Azure.ResourceManager.ArmResponse} The Azure Resource Manager synchronous OK response @@ -229,6 +373,13 @@ model Azure.ResourceManager.ArmResponse | ------------ | --------------------------------- | | ResponseBody | The contents of the response body | +#### Properties + +| Name | Type | Description | +| ---------- | -------------- | --------------------------------------------------- | +| statusCode | `200` | The status code. | +| body | `ResponseBody` | The body type of the operation request or response. | + ### `CustomerManagedKeyEncryption` {#Azure.ResourceManager.CustomerManagedKeyEncryption} Customer-managed key encryption properties for the resource. @@ -237,6 +388,15 @@ Customer-managed key encryption properties for the resource. model Azure.ResourceManager.CustomerManagedKeyEncryption ``` +#### Properties + +| Name | Type | Description | +| ------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| keyEncryptionIdentity? | [`KeyEncryptionIdentity`](./data-types.md#Azure.ResourceManager.KeyEncryptionIdentity) | The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity. | +| userAssignedIdentityResourceId? | [`ResourceIdentifier`](#Azure.ResourceManager.ResourceIdentifier) | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. | +| federatedClientId? | `Core.uuid` | application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 | +| delegatedIdentityClientId | `Core.uuid` | delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only. | + ### `DefaultProvisioningStateProperty` {#Azure.ResourceManager.DefaultProvisioningStateProperty} Standard resource provisioning state model. If you do not have any custom provisioning state, @@ -255,6 +415,12 @@ model FooProperties { } ``` +#### Properties + +| Name | Type | Description | +| ------------------ | ---------------------------------------------------------------------------------------------- | --------------------------------------- | +| provisioningState? | [`ResourceProvisioningState`](./data-types.md#Azure.ResourceManager.ResourceProvisioningState) | The provisioning state of the resource. | + ### `Encryption` {#Azure.ResourceManager.Encryption} Model used only to spread in the `encryption` envelope property for a resource. @@ -271,6 +437,12 @@ model Foo is TrackedResource { } ``` +#### Properties + +| Name | Type | Description | +| ---------- | ------------------------------------------------------------------------------------------ | -------------------------------------------- | +| encryption | [`EncryptionConfiguration`](./data-types.md#Azure.ResourceManager.EncryptionConfiguration) | All encryption configuration for a resource. | + ### `EncryptionConfiguration` {#Azure.ResourceManager.EncryptionConfiguration} All encryption configuration for a resource. @@ -279,6 +451,14 @@ All encryption configuration for a resource. model Azure.ResourceManager.EncryptionConfiguration ``` +#### Properties + +| Name | Type | Description | +| ----------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| infrastructureEncryption? | [`InfrastructureEncryption`](./data-types.md#Azure.ResourceManager.InfrastructureEncryption) | Indicates if infrastructure encryption is enabled or disabled. | +| customerManagedKeyEncryption? | [`CustomerManagedKeyEncryption`](./data-types.md#Azure.ResourceManager.CustomerManagedKeyEncryption) | All customer-managed key encryption properties for the resource. | +| keyEncryptionKeyUrl? | `string` | key encryption key Url, versioned or unversioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. | + ### `EntityTag` {#Azure.ResourceManager.EntityTag} Model used only to spread in the standard `eTag` envelope property for a resource @@ -296,6 +476,12 @@ model Foo is TrackedResource { } ``` +#### Properties + +| Name | Type | Description | +| ----- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| eTag? | `string` | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | + ### `ErrorResponse` {#Azure.ResourceManager.ErrorResponse} The standard Azure Resource Manager error response @@ -304,6 +490,12 @@ The standard Azure Resource Manager error response model Azure.ResourceManager.ErrorResponse ``` +#### Properties + +| Name | Type | Description | +| ------ | ------------------------------------------------------------------------------ | ----------------- | +| error? | [`ErrorDetail`](./data-types.md#Azure.ResourceManager.Foundations.ErrorDetail) | The error object. | + ### `ExtensionResource` {#Azure.ResourceManager.ExtensionResource} Concrete extension resource types can be created by aliasing this type using a specific property type. @@ -320,6 +512,12 @@ model Azure.ResourceManager.ExtensionResource | ---------- | --------------------------------------------------------------------- | | Properties | A model containing the provider-specific properties for this resource | +#### Properties + +| Name | Type | Description | +| ----------- | ------------ | ----------- | +| properties? | `Properties` | | + ### `KeysOf` {#Azure.ResourceManager.KeysOf} Extracts the key (path) parameters from a resource and its parents @@ -334,6 +532,10 @@ model Azure.ResourceManager.KeysOf | -------- | --------------------------------------- | | Resource | The resource to extract properties from | +#### Properties + +None + ### `LocationParameter` {#Azure.ResourceManager.LocationParameter} DEPRECATED - DO NOT USE @@ -343,6 +545,12 @@ The default location parameter type. model Azure.ResourceManager.LocationParameter ``` +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------ | +| location | `string` | The location name. | + ### `LocationResourceParameter` {#Azure.ResourceManager.LocationResourceParameter} The default location parameter type. @@ -351,6 +559,12 @@ The default location parameter type. model Azure.ResourceManager.LocationResourceParameter ``` +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------ | +| location | `string` | The location name. | + ### `ManagedBy` {#Azure.ResourceManager.ManagedBy} Model used only to spread in the standard `managedBy` envelope property for a resource @@ -368,6 +582,12 @@ model Foo is TrackedResource { } ``` +#### Properties + +| Name | Type | Description | +| ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| managedBy? | `string` | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. | + ### `ManagedServiceIdentity` {#Azure.ResourceManager.ManagedServiceIdentity} Standard Azure Resource Manager definition of ManagedServiceIdentity @@ -376,6 +596,12 @@ Standard Azure Resource Manager definition of ManagedServiceIdentity model Azure.ResourceManager.ManagedServiceIdentity ``` +#### Properties + +| Name | Type | Description | +| --------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| identity? | [`ManagedIdentityProperties`](./data-types.md#Azure.ResourceManager.Foundations.ManagedIdentityProperties) | The managed service identities assigned to this resource. | + ### `ManagedSystemAssignedIdentity` {#Azure.ResourceManager.ManagedSystemAssignedIdentity} Standard Azure Resource Manager definition of ManagedServiceIdentity for services @@ -385,6 +611,12 @@ that only support system-defined identities model Azure.ResourceManager.ManagedSystemAssignedIdentity ``` +#### Properties + +| Name | Type | Description | +| --------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| identity? | [`ManagedSystemIdentityProperties`](./data-types.md#Azure.ResourceManager.Foundations.ManagedSystemIdentityProperties) | The managed service identities assigned to this resource. | + ### `ParentKeysOf` {#Azure.ResourceManager.ParentKeysOf} Extracts the key (path) parameters from the parent(s) of the given resource @@ -399,6 +631,10 @@ model Azure.ResourceManager.ParentKeysOf | -------- | --------------------------------------- | | Resource | The resource to extract properties from | +#### Properties + +None + ### `PrivateEndpoint` {#Azure.ResourceManager.PrivateEndpoint} The private endpoint resource @@ -407,6 +643,12 @@ The private endpoint resource model Azure.ResourceManager.PrivateEndpoint ``` +#### Properties + +| Name | Type | Description | +| ---- | ----------------------------------------------------------------- | -------------------------------------------- | +| id? | [`ResourceIdentifier`](#Azure.ResourceManager.ResourceIdentifier) | The resource identifier for private endpoint | + ### `PrivateEndpointConnection` {#Azure.ResourceManager.PrivateEndpointConnection} The private endpoint connection resource @@ -415,6 +657,12 @@ The private endpoint connection resource model Azure.ResourceManager.PrivateEndpointConnection ``` +#### Properties + +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | +| properties? | [`PrivateEndpointConnectionProperties`](./data-types.md#Azure.ResourceManager.PrivateEndpointConnectionProperties) | The private endpoint connection properties | + ### `PrivateEndpointConnectionParameter` {#Azure.ResourceManager.PrivateEndpointConnectionParameter} The name of the private endpoint connection associated with the Azure resource. @@ -429,6 +677,12 @@ model Azure.ResourceManager.PrivateEndpointConnectionParameter | ------- | ----------------------------------------------------------------------------------------------- | | Segment | The resource type name for private endpoint connections (default is privateEndpointConnections) | +#### Properties + +| Name | Type | Description | +| ---- | -------- | ------------------------------------------------------------------------------- | +| name | `string` | The name of the private endpoint connection associated with the Azure resource. | + ### `PrivateEndpointConnectionProperties` {#Azure.ResourceManager.PrivateEndpointConnectionProperties} Properties of he private endpoint connection resource @@ -437,6 +691,15 @@ Properties of he private endpoint connection resource model Azure.ResourceManager.PrivateEndpointConnectionProperties ``` +#### Properties + +| Name | Type | Description | +| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| groupIds? | `string[]` | The group identifiers for the private endpoint resource | +| privateEndpoint? | [`PrivateEndpoint`](./data-types.md#Azure.ResourceManager.PrivateEndpoint) | The private endpoint resource | +| privateLinkServiceConnectionState | [`PrivateLinkServiceConnectionState`](./data-types.md#Azure.ResourceManager.PrivateLinkServiceConnectionState) | A collection of information about the state of the connection between service consumer and provider. | +| provisioningState? | [`PrivateEndpointConnectionProvisioningState`](./data-types.md#Azure.ResourceManager.PrivateEndpointConnectionProvisioningState) | The provisioning state of the private endpoint connection resource. | + ### `PrivateEndpointConnectionResourceListResult` {#Azure.ResourceManager.PrivateEndpointConnectionResourceListResult} List of private endpoint connections associated with the specified resource. @@ -445,12 +708,24 @@ List of private endpoint connections associated with the specified resource. model Azure.ResourceManager.PrivateEndpointConnectionResourceListResult ``` +#### Properties + +| Name | Type | Description | +| ------ | --------------------------------------------- | ------------------------------------- | +| value? | `ResourceManager.PrivateEndpointConnection[]` | Array of private endpoint connections | + ### `PrivateLinkResource` {#Azure.ResourceManager.PrivateLinkResource} ```typespec model Azure.ResourceManager.PrivateLinkResource ``` +#### Properties + +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------- | +| properties? | [`PrivateLinkResourceProperties`](./data-types.md#Azure.ResourceManager.PrivateLinkResourceProperties) | Properties of the private link resource. | + ### `PrivateLinkResourceListResult` {#Azure.ResourceManager.PrivateLinkResourceListResult} A list of private link resources. @@ -459,6 +734,12 @@ A list of private link resources. model Azure.ResourceManager.PrivateLinkResourceListResult ``` +#### Properties + +| Name | Type | Description | +| ------ | --------------------------------------- | ------------------------------- | +| value? | `ResourceManager.PrivateLinkResource[]` | Array of private link resources | + ### `PrivateLinkResourceParameter` {#Azure.ResourceManager.PrivateLinkResourceParameter} The name of the private link associated with the Azure resource. @@ -473,6 +754,12 @@ model Azure.ResourceManager.PrivateLinkResourceParameter | ------- | -------------------------------------------------------------------------- | | Segment | The resource type name for private links (default is privateLinkResources) | +#### Properties + +| Name | Type | Description | +| ---- | -------- | ---------------------------------------------------------------- | +| name | `string` | The name of the private link associated with the Azure resource. | + ### `PrivateLinkResourceProperties` {#Azure.ResourceManager.PrivateLinkResourceProperties} Properties of a private link resource. @@ -481,6 +768,14 @@ Properties of a private link resource. model Azure.ResourceManager.PrivateLinkResourceProperties ``` +#### Properties + +| Name | Type | Description | +| ------------------ | ---------- | ----------------------------------------------------- | +| groupId? | `string` | The private link resource group id. | +| requiredMembers? | `string[]` | The private link resource required member names. | +| requiredZoneNames? | `string[]` | The private link resource private link DNS zone name. | + ### `PrivateLinkServiceConnectionState` {#Azure.ResourceManager.PrivateLinkServiceConnectionState} A collection of information about the state of the connection between service consumer and provider. @@ -489,6 +784,14 @@ A collection of information about the state of the connection between service co model Azure.ResourceManager.PrivateLinkServiceConnectionState ``` +#### Properties + +| Name | Type | Description | +| ---------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| status? | [`PrivateEndpointServiceConnectionStatus`](./data-types.md#Azure.ResourceManager.PrivateEndpointServiceConnectionStatus) | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | +| description? | `string` | The reason for approval/rejection of the connection. | +| actionsRequired? | `string` | A message indicating if changes on the service provider require any updates on the consumer. | + ### `ProviderNamespace` {#Azure.ResourceManager.ProviderNamespace} Model describing the provider namespace. @@ -503,6 +806,12 @@ model Azure.ResourceManager.ProviderNamespace | -------- | --------------------------------------- | | Resource | The resource provided by the namespace. | +#### Properties + +| Name | Type | Description | +| -------- | -------------------------------- | ----------- | +| provider | `"Microsoft.ThisWillBeReplaced"` | | + ### `ProxyResource` {#Azure.ResourceManager.ProxyResource} Concrete proxy resource types can be created by aliasing this type using a specific property type. @@ -519,6 +828,12 @@ model Azure.ResourceManager.ProxyResource | ---------- | --------------------------------------------------------------------- | | Properties | A model containing the provider-specific properties for this resource | +#### Properties + +| Name | Type | Description | +| ----------- | ------------ | ----------- | +| properties? | `Properties` | | + ### `ResourceGroupLocationResource` {#Azure.ResourceManager.ResourceGroupLocationResource} The location resource for resourceGroup-based locations. This can be used as a parent @@ -528,6 +843,12 @@ resource for resource types that are homed in a resourceGroup-based location. model Azure.ResourceManager.ResourceGroupLocationResource ``` +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------ | +| location | `string` | The location name. | + ### `ResourceGroupParameter` {#Azure.ResourceManager.ResourceGroupParameter} The default resource group parameter type. @@ -536,6 +857,12 @@ The default resource group parameter type. model Azure.ResourceManager.ResourceGroupParameter ``` +#### Properties + +| Name | Type | Description | +| ----------------- | -------- | ------------------------------------------------------------- | +| resourceGroupName | `string` | The name of the resource group. The name is case insensitive. | + ### `ResourceIdentifierAllowedResource` {#Azure.ResourceManager.ResourceIdentifierAllowedResource} Used in ResourceIdentifier definition to represent a particular type of Azure Resource Manager resource, enabling constraints based on resource type. @@ -545,6 +872,13 @@ See [link](https://github.com/Azure/autorest/tree/main/docs/extensions#schema) model Azure.ResourceManager.ResourceIdentifierAllowedResource ``` +#### Properties + +| Name | Type | Description | +| ------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | The type of resource that is being referred to. For example Microsoft.Network/virtualNetworks or Microsoft.Network/virtualNetworks/subnets. See Example Types for more examples. | +| scopes? | `string[]` | An array of scopes. If not specified, the default scope is ["ResourceGroup"].
See [Allowed Scopes](https://github.com/Azure/autorest/tree/main/docs/extensions#allowed-scopes). | + ### `ResourceInstanceParameters` {#Azure.ResourceManager.ResourceInstanceParameters} The dynamic parameters of a resource instance - pass in the proper base type to indicate @@ -561,6 +895,12 @@ model Azure.ResourceManager.ResourceInstanceParameters | Resource | The resource to get parameters for | | BaseParameters | The parameters representing the base Uri of the resource | +#### Properties + +| Name | Type | Description | +| -------- | -------------------------------- | ---------------------------------------- | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `ResourceKind` {#Azure.ResourceManager.ResourceKind} Model used only to spread in the standard `kind` envelope property for a resource @@ -578,6 +918,12 @@ model Foo is TrackedResource { } ``` +#### Properties + +| Name | Type | Description | +| ----- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| kind? | `string` | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. | + ### `ResourceListResult` {#Azure.ResourceManager.ResourceListResult} Paged response containing resources @@ -592,6 +938,13 @@ model Azure.ResourceManager.ResourceListResult | -------- | -------------------------------------------------------------------------- | | Resource | The type of the values returned in the paged response (must be a resource) | +#### Properties + +| Name | Type | Description | +| --------- | -------------------------------- | ---------------------------------- | +| value | `Array` | The {name} items on this page | +| nextLink? | `TypeSpec.Rest.ResourceLocation` | The link to the next page of items | + ### `ResourceParentParameters` {#Azure.ResourceManager.ResourceParentParameters} The dynamic parameters of a list call for a resource instance - pass in the proper base type to indicate @@ -608,6 +961,12 @@ model Azure.ResourceManager.ResourceParentParameters | Resource | The resource to get parameters for | | BaseParameters | The parameters representing the base Uri of the resource | +#### Properties + +| Name | Type | Description | +| -------- | -------------------------------- | ---------------------------------------- | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `ResourcePlan` {#Azure.ResourceManager.ResourcePlan} Model used only to spread in the standard `plan` envelope property for a resource @@ -625,6 +984,12 @@ model Foo is TrackedResource { } ``` +#### Properties + +| Name | Type | Description | +| ----- | ---------------------------------------------------------------------------------------- | ----------------------------- | +| plan? | [`ResourcePlanType`](./data-types.md#Azure.ResourceManager.Foundations.ResourcePlanType) | Details of the resource plan. | + ### `ResourceSku` {#Azure.ResourceManager.ResourceSku} Model used only to spread in the standard `sku` envelope property for a resource @@ -642,6 +1007,12 @@ model Foo is TrackedResource { } ``` +#### Properties + +| Name | Type | Description | +| ---- | -------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| sku? | [`ResourceSkuType`](./data-types.md#Azure.ResourceManager.Foundations.ResourceSkuType) | The SKU (Stock Keeping Unit) assigned to this resource. | + ### `ResourceUriParameter` {#Azure.ResourceManager.ResourceUriParameter} The default resourceUri parameter type. @@ -650,6 +1021,12 @@ The default resourceUri parameter type. model Azure.ResourceManager.ResourceUriParameter ``` +#### Properties + +| Name | Type | Description | +| ----------- | -------- | ---------------------------------------------------------------------- | +| resourceUri | `string` | The fully qualified Azure Resource manager identifier of the resource. | + ### `SubscriptionIdParameter` {#Azure.ResourceManager.SubscriptionIdParameter} The default subscriptionId parameter type. @@ -658,6 +1035,12 @@ The default subscriptionId parameter type. model Azure.ResourceManager.SubscriptionIdParameter ``` +#### Properties + +| Name | Type | Description | +| -------------- | -------- | ---------------------------------- | +| subscriptionId | `string` | The ID of the target subscription. | + ### `SubscriptionLocationResource` {#Azure.ResourceManager.SubscriptionLocationResource} The location resource for subscription-based locations. This can be used as a parent @@ -667,6 +1050,12 @@ resource for resource types that are homed in a subscription-based location. model Azure.ResourceManager.SubscriptionLocationResource ``` +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------ | +| location | `string` | The location name. | + ### `TenantLocationResource` {#Azure.ResourceManager.TenantLocationResource} The location resource for tenant-based locations. This can be used as a parent @@ -676,6 +1065,12 @@ resource for resource types that are homed in a tenant-based location. model Azure.ResourceManager.TenantLocationResource ``` +#### Properties + +| Name | Type | Description | +| -------- | -------- | ------------------ | +| location | `string` | The location name. | + ### `TrackedResource` {#Azure.ResourceManager.TrackedResource} Concrete tracked resource types can be created by aliasing this type using a specific property type. @@ -692,6 +1087,12 @@ model Azure.ResourceManager.TrackedResource | ---------- | --------------------------------------------------------------------- | | Properties | A model containing the provider-specific properties for this resource | +#### Properties + +| Name | Type | Description | +| ----------- | ------------ | ----------- | +| properties? | `Properties` | | + ### `InfrastructureEncryption` {#Azure.ResourceManager.InfrastructureEncryption} (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled. @@ -812,6 +1213,14 @@ Base model that defines common properties for all Azure Resource Manager resourc model Azure.ResourceManager.Foundations.ArmResource ``` +#### Properties + +| Name | Type | Description | +| ----------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | `string` | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | +| type | `string` | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" | +| systemData? | [`SystemData`](./data-types.md#Azure.ResourceManager.Foundations.SystemData) | Azure Resource Manager metadata containing createdBy and modifiedBy information. | + ### `ArmResourceBase` {#Azure.ResourceManager.Foundations.ArmResourceBase} Base class used for type definitions @@ -820,6 +1229,10 @@ Base class used for type definitions model Azure.ResourceManager.Foundations.ArmResourceBase ``` +#### Properties + +None + ### `ArmTagsProperty` {#Azure.ResourceManager.Foundations.ArmTagsProperty} Standard type definition for Azure Resource Manager Tags property. @@ -830,6 +1243,12 @@ It is included in the TrackedResource template definition. model Azure.ResourceManager.Foundations.ArmTagsProperty ``` +#### Properties + +| Name | Type | Description | +| ----- | ---------------- | -------------- | +| tags? | `Record` | Resource tags. | + ### `CheckNameAvailabilityRequest` {#Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest} The check availability request body. @@ -838,6 +1257,13 @@ The check availability request body. model Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest ``` +#### Properties + +| Name | Type | Description | +| ----- | -------- | -------------------------------------------------------------------- | +| name? | `string` | The name of the resource for which availability needs to be checked. | +| type? | `string` | The resource type. | + ### `CheckNameAvailabilityResponse` {#Azure.ResourceManager.Foundations.CheckNameAvailabilityResponse} The check availability result. @@ -846,6 +1272,14 @@ The check availability result. model Azure.ResourceManager.Foundations.CheckNameAvailabilityResponse ``` +#### Properties + +| Name | Type | Description | +| -------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| nameAvailable? | `boolean` | Indicates if the resource name is available. | +| reason? | [`CheckNameAvailabilityReason`](./data-types.md#Azure.ResourceManager.Foundations.CheckNameAvailabilityReason) | The reason why the given name is not available. | +| message? | `string` | Detailed reason why the given name is not available. | + ### `DefaultBaseParameters` {#Azure.ResourceManager.Foundations.DefaultBaseParameters} Base parameters for a resource. @@ -860,6 +1294,16 @@ model Azure.ResourceManager.Foundations.DefaultBaseParameters | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| ----------------- | -------- | ---------------------------------------------------------------------- | +| apiVersion | `string` | The API version to use for this operation. | +| subscriptionId | `string` | The ID of the target subscription. | +| location | `string` | The location name. | +| resourceGroupName | `string` | The name of the resource group. The name is case insensitive. | +| resourceUri | `string` | The fully qualified Azure Resource manager identifier of the resource. | + ### `ErrorAdditionalInfo` {#Azure.ResourceManager.Foundations.ErrorAdditionalInfo} The resource management error additional info. @@ -868,6 +1312,13 @@ The resource management error additional info. model Azure.ResourceManager.Foundations.ErrorAdditionalInfo ``` +#### Properties + +| Name | Type | Description | +| ----- | -------- | ------------------------- | +| type? | `string` | The additional info type. | +| info? | `{}` | The additional info. | + ### `ErrorDetail` {#Azure.ResourceManager.Foundations.ErrorDetail} The error detail. @@ -876,6 +1327,16 @@ The error detail. model Azure.ResourceManager.Foundations.ErrorDetail ``` +#### Properties + +| Name | Type | Description | +| --------------- | --------------------------------------------------- | -------------------------- | +| code? | `string` | The error code. | +| message? | `string` | The error message. | +| target? | `string` | The error target. | +| details? | `ResourceManager.Foundations.ErrorDetail[]` | The error details. | +| additionalInfo? | `ResourceManager.Foundations.ErrorAdditionalInfo[]` | The error additional info. | + ### `ExtensionBaseParameters` {#Azure.ResourceManager.Foundations.ExtensionBaseParameters} The static parameters for an extension resource @@ -884,6 +1345,13 @@ The static parameters for an extension resource model Azure.ResourceManager.Foundations.ExtensionBaseParameters ``` +#### Properties + +| Name | Type | Description | +| ----------- | -------- | ---------------------------------------------------------------------- | +| apiVersion | `string` | The API version to use for this operation. | +| resourceUri | `string` | The fully qualified Azure Resource manager identifier of the resource. | + ### `ExtensionResourceBase` {#Azure.ResourceManager.Foundations.ExtensionResourceBase} The base extension resource. @@ -892,6 +1360,10 @@ The base extension resource. model Azure.ResourceManager.Foundations.ExtensionResourceBase ``` +#### Properties + +None + ### `ExtensionScope` {#Azure.ResourceManager.Foundations.ExtensionScope} Parameter model for listing an extension resource @@ -906,6 +1378,14 @@ model Azure.ResourceManager.Foundations.ExtensionScope | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| ----------- | -------------------------------- | ---------------------------------------------------------------------- | +| apiVersion | `string` | The API version to use for this operation. | +| resourceUri | `string` | The fully qualified Azure Resource manager identifier of the resource. | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `LocationBaseParameters` {#Azure.ResourceManager.Foundations.LocationBaseParameters} The static parameters for a location-based resource @@ -914,6 +1394,14 @@ The static parameters for a location-based resource model Azure.ResourceManager.Foundations.LocationBaseParameters ``` +#### Properties + +| Name | Type | Description | +| -------------- | -------- | ------------------------------------------ | +| apiVersion | `string` | The API version to use for this operation. | +| subscriptionId | `string` | The ID of the target subscription. | +| location | `string` | The location name. | + ### `LocationScope` {#Azure.ResourceManager.Foundations.LocationScope} Parameter model for listing a resource at the location scope @@ -928,6 +1416,15 @@ model Azure.ResourceManager.Foundations.LocationScope | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| -------------- | -------------------------------- | ------------------------------------------ | +| apiVersion | `string` | The API version to use for this operation. | +| subscriptionId | `string` | The ID of the target subscription. | +| location | `string` | The location name. | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `ManagedIdentityProperties` {#Azure.ResourceManager.Foundations.ManagedIdentityProperties} The properties of the managed service identities assigned to this resource. @@ -936,6 +1433,15 @@ The properties of the managed service identities assigned to this resource. model Azure.ResourceManager.Foundations.ManagedIdentityProperties ``` +#### Properties + +| Name | Type | Description | +| ----------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| tenantId? | `string` | The Active Directory tenant id of the principal. | +| principalId? | `string` | The active directory identifier of this principal. | +| type | [`ManagedIdentityType`](./data-types.md#Azure.ResourceManager.Foundations.ManagedIdentityType) | The type of managed identity assigned to this resource. | +| userAssignedIdentities? | `Record` | The identities assigned to this resource by the user. | + ### `ManagedSystemIdentityProperties` {#Azure.ResourceManager.Foundations.ManagedSystemIdentityProperties} The properties of the service-assigned identity associated with this resource. @@ -944,6 +1450,14 @@ The properties of the service-assigned identity associated with this resource. model Azure.ResourceManager.Foundations.ManagedSystemIdentityProperties ``` +#### Properties + +| Name | Type | Description | +| ------------ | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| tenantId? | `string` | The Active Directory tenant id of the principal. | +| principalId? | `string` | The active directory identifier of this principal. | +| type | [`ManagedSystemIdentityType`](./data-types.md#Azure.ResourceManager.Foundations.ManagedSystemIdentityType) | The type of managed identity assigned to this resource. | + ### `Operation` {#Azure.ResourceManager.Foundations.Operation} Details of a REST API operation, returned from the Resource Provider Operations API @@ -952,6 +1466,16 @@ Details of a REST API operation, returned from the Resource Provider Operations model Azure.ResourceManager.Foundations.Operation ``` +#### Properties + +| Name | Type | Description | +| ------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name? | `string` | The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" | +| isDataAction? | `boolean` | Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations. | +| display? | [`OperationDisplay`](./data-types.md#Azure.ResourceManager.Foundations.OperationDisplay) | Localized display information for this particular operation. | +| origin? | [`Origin`](./data-types.md#Azure.ResourceManager.Foundations.Origin) | The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" | +| actionType? | [`ActionType`](./data-types.md#Azure.ResourceManager.Foundations.ActionType) | Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. | + ### `OperationDisplay` {#Azure.ResourceManager.Foundations.OperationDisplay} Localized display information for and operation. @@ -960,6 +1484,15 @@ Localized display information for and operation. model Azure.ResourceManager.Foundations.OperationDisplay ``` +#### Properties + +| Name | Type | Description | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| provider? | `string` | The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". | +| resource? | `string` | The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". | +| operation? | `string` | The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". | +| description? | `string` | The short, localized friendly description of the operation; suitable for tool tips and detailed views. | + ### `OperationIdParameter` {#Azure.ResourceManager.Foundations.OperationIdParameter} The default operationId parameter type. @@ -968,6 +1501,12 @@ The default operationId parameter type. model Azure.ResourceManager.Foundations.OperationIdParameter ``` +#### Properties + +| Name | Type | Description | +| ----------- | -------- | ------------------------------------- | +| operationId | `string` | The ID of an ongoing async operation. | + ### `OperationListResult` {#Azure.ResourceManager.Foundations.OperationListResult} A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. @@ -976,6 +1515,13 @@ A list of REST API operations supported by an Azure Resource Provider. It contai model Azure.ResourceManager.Foundations.OperationListResult ``` +#### Properties + +| Name | Type | Description | +| --------- | ----------------------------------------- | ---------------------------------- | +| value | `ResourceManager.Foundations.Operation[]` | The Operation items on this page | +| nextLink? | `TypeSpec.Rest.ResourceLocation` | The link to the next page of items | + ### `OperationStatusResult` {#Azure.ResourceManager.Foundations.OperationStatusResult} The current status of an async operation. @@ -984,6 +1530,19 @@ The current status of an async operation. model Azure.ResourceManager.Foundations.OperationStatusResult ``` +#### Properties + +| Name | Type | Description | +| ---------------- | ------------------------------------------------------------------------------ | ------------------------------------------- | +| id? | `string` | Fully qualified ID for the async operation. | +| name? | `string` | Name of the async operation. | +| status | `string` | Operation status. | +| percentComplete? | `int32` | Percent of the operation that is complete. | +| startTime? | `utcDateTime` | The start time of the operation. | +| endTime? | `utcDateTime` | The end time of the operation. | +| operations | `ResourceManager.Foundations.OperationStatusResult[]` | The operations list. | +| error? | [`ErrorDetail`](./data-types.md#Azure.ResourceManager.Foundations.ErrorDetail) | If present, details of the operation error. | + ### `ProxyResourceBase` {#Azure.ResourceManager.Foundations.ProxyResourceBase} The base proxy resource. @@ -992,6 +1551,10 @@ The base proxy resource. model Azure.ResourceManager.Foundations.ProxyResourceBase ``` +#### Properties + +None + ### `ProxyResourceUpdateModel` {#Azure.ResourceManager.Foundations.ProxyResourceUpdateModel} The type used for update operations of the resource. @@ -1007,6 +1570,12 @@ model Azure.ResourceManager.Foundations.ProxyResourceUpdateModel` | | + ### `ResourceGroupBaseParameters` {#Azure.ResourceManager.Foundations.ResourceGroupBaseParameters} The static parameters for a resource-group based resource @@ -1015,6 +1584,14 @@ The static parameters for a resource-group based resource model Azure.ResourceManager.Foundations.ResourceGroupBaseParameters ``` +#### Properties + +| Name | Type | Description | +| ----------------- | -------- | ------------------------------------------------------------- | +| apiVersion | `string` | The API version to use for this operation. | +| subscriptionId | `string` | The ID of the target subscription. | +| resourceGroupName | `string` | The name of the resource group. The name is case insensitive. | + ### `ResourceGroupScope` {#Azure.ResourceManager.Foundations.ResourceGroupScope} Parameter model for listing a resource at the resource group scope @@ -1029,6 +1606,17 @@ model Azure.ResourceManager.Foundations.ResourceGroupScope | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| ----------------- | -------------------------------- | ---------------------------------------------------------------------- | +| apiVersion | `string` | The API version to use for this operation. | +| subscriptionId | `string` | The ID of the target subscription. | +| location | `string` | The location name. | +| resourceGroupName | `string` | The name of the resource group. The name is case insensitive. | +| resourceUri | `string` | The fully qualified Azure Resource manager identifier of the resource. | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `ResourcePlanType` {#Azure.ResourceManager.Foundations.ResourcePlanType} Details of the resource plan. @@ -1037,6 +1625,16 @@ Details of the resource plan. model Azure.ResourceManager.Foundations.ResourcePlanType ``` +#### Properties + +| Name | Type | Description | +| -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | A user defined name of the 3rd Party Artifact that is being procured. | +| publisher | `string` | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | +| product | `string` | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | +| promotionCode? | `string` | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | +| version? | `string` | The version of the desired product/artifact. | + ### `ResourceSkuType` {#Azure.ResourceManager.Foundations.ResourceSkuType} The SKU (Stock Keeping Unit) assigned to this resource. @@ -1045,6 +1643,16 @@ The SKU (Stock Keeping Unit) assigned to this resource. model Azure.ResourceManager.Foundations.ResourceSkuType ``` +#### Properties + +| Name | Type | Description | +| --------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | The name of the SKU, usually a combination of letters and numbers, for example, 'P3' | +| tier? | [`SkuTier`](./data-types.md#Azure.ResourceManager.Foundations.SkuTier) | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | +| size? | `string` | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | +| family? | `string` | If the service has different generations of hardware, for the same SKU, then that can be captured here. | +| capacity? | `int32` | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | + ### `ResourceUpdateModel` {#Azure.ResourceManager.Foundations.ResourceUpdateModel} Defines a model type used to create named resource update models @@ -1061,6 +1669,12 @@ model Azure.ResourceManager.Foundations.ResourceUpdateModel` | | + ### `ResourceUpdateModelProperties` {#Azure.ResourceManager.Foundations.ResourceUpdateModelProperties} Defines a properties type used to create named resource update models. @@ -1077,6 +1691,10 @@ model Azure.ResourceManager.Foundations.ResourceUpdateModelProperties | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| -------------- | -------------------------------- | ------------------------------------------ | +| apiVersion | `string` | The API version to use for this operation. | +| subscriptionId | `string` | The ID of the target subscription. | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `SystemData` {#Azure.ResourceManager.Foundations.SystemData} Metadata pertaining to creation and last modification of the resource. @@ -1107,6 +1740,17 @@ Metadata pertaining to creation and last modification of the resource. model Azure.ResourceManager.Foundations.SystemData ``` +#### Properties + +| Name | Type | Description | +| ------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------- | +| createdBy? | `string` | The identity that created the resource. | +| createdByType? | [`createdByType`](./data-types.md#Azure.ResourceManager.Foundations.createdByType) | The type of identity that created the resource. | +| createdAt? | `plainDate` | The type of identity that created the resource. | +| lastModifiedBy? | `string` | The identity that last modified the resource. | +| lastModifiedByType? | [`createdByType`](./data-types.md#Azure.ResourceManager.Foundations.createdByType) | The type of identity that last modified the resource. | +| lastModifiedAt? | `plainDate` | The timestamp of resource last modification (UTC) | + ### `TagsUpdateModel` {#Azure.ResourceManager.Foundations.TagsUpdateModel} The type used for updating tags in resources. @@ -1121,6 +1765,12 @@ model Azure.ResourceManager.Foundations.TagsUpdateModel | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| ----- | ---------------- | -------------- | +| tags? | `Record` | Resource tags. | + ### `TenantBaseParameters` {#Azure.ResourceManager.Foundations.TenantBaseParameters} The static parameters for a tenant-based resource @@ -1129,6 +1779,12 @@ The static parameters for a tenant-based resource model Azure.ResourceManager.Foundations.TenantBaseParameters ``` +#### Properties + +| Name | Type | Description | +| ---------- | -------- | ------------------------------------------ | +| apiVersion | `string` | The API version to use for this operation. | + ### `TenantScope` {#Azure.ResourceManager.Foundations.TenantScope} Parameter model for listing a resource at the tenant scope @@ -1143,6 +1799,13 @@ model Azure.ResourceManager.Foundations.TenantScope | -------- | ------------------------- | | Resource | The type of the resource. | +#### Properties + +| Name | Type | Description | +| ---------- | -------------------------------- | ------------------------------------------ | +| apiVersion | `string` | The API version to use for this operation. | +| provider | `"Microsoft.ThisWillBeReplaced"` | The provider namespace for the resource. | + ### `TrackedResourceBase` {#Azure.ResourceManager.Foundations.TrackedResourceBase} The base tracked resource. @@ -1151,6 +1814,13 @@ The base tracked resource. model Azure.ResourceManager.Foundations.TrackedResourceBase ``` +#### Properties + +| Name | Type | Description | +| -------- | ---------------- | ----------------------------------------- | +| location | `string` | The geo-location where the resource lives | +| tags? | `Record` | Resource tags. | + ### `UserAssignedIdentity` {#Azure.ResourceManager.Foundations.UserAssignedIdentity} A managed identity assigned by the user. @@ -1159,6 +1829,13 @@ A managed identity assigned by the user. model Azure.ResourceManager.Foundations.UserAssignedIdentity ``` +#### Properties + +| Name | Type | Description | +| ------------ | -------- | ---------------------------------------------------------- | +| clientId? | `string` | The active directory client identifier for this principal. | +| principalId? | `string` | The active directory identifier for this principal. | + ### `ActionType` {#Azure.ResourceManager.Foundations.ActionType} Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/decorators.md index 19f6389a64..7f8fbcdc0b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/decorators.md @@ -19,13 +19,13 @@ the version of the Azure Resource Manager common-types to use for refs in emitte #### Target -`union Namespace | EnumMember` +`Namespace | EnumMember` #### Parameters -| Name | Type | Description | -| ------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| version | `valueof union string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value. | +| Name | Type | Description | +| ------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| version | `valueof string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value. | ### `@armLibraryNamespace` {#@Azure.ResourceManager.armLibraryNamespace} @@ -65,9 +65,9 @@ Namespace element value unless an override value is specified. #### Parameters -| Name | Type | Description | -| ----------------- | ----------------------- | ------------------ | -| providerNamespace | `valueof scalar string` | Provider namespace | +| Name | Type | Description | +| ----------------- | ---------------- | ------------------ | +| providerNamespace | `valueof string` | Provider namespace | #### Examples @@ -92,7 +92,7 @@ property to the type of the Azure Resource Manager resource. #### Target -`union Operation | Model` +`Operation | Model` #### Parameters @@ -112,11 +112,11 @@ Marks the operation as being a collection action #### Parameters -| Name | Type | Description | -| ---------------------- | ----------------------- | ------------------------- | -| resourceType | `Model` | Resource | -| parentTypeName | `valueof scalar string` | : Parent type name. | -| parentFriendlyTypeName | `valueof scalar string` | Friendly name for parent. | +| Name | Type | Description | +| ---------------------- | ---------------- | ------------------------- | +| resourceType | `Model` | Resource | +| parentTypeName | `valueof string` | : Parent type name. | +| parentFriendlyTypeName | `valueof string` | Friendly name for parent. | ### `@armResourceAction` {#@Azure.ResourceManager.armResourceAction} @@ -219,9 +219,9 @@ clients. #### Parameters -| Name | Type | Description | -| ---- | --------------------- | ----------- | -| \_ | `(intrinsic) unknown` | DEPRECATED | +| Name | Type | Description | +| ---- | --------- | ----------- | +| \_ | `unknown` | DEPRECATED | ### `@armResourceRead` {#@Azure.ResourceManager.armResourceRead} @@ -320,7 +320,7 @@ None This decorator sets the base type of the given resource. ```typespec -@Azure.ResourceManager.resourceBaseType(baseType: Tenant | Subscription | ResourceGroup | Location | Extension) +@Azure.ResourceManager.resourceBaseType(baseType: "Tenant" | "Subscription" | "ResourceGroup" | "Location" | "Extension") ``` #### Target @@ -329,9 +329,9 @@ This decorator sets the base type of the given resource. #### Parameters -| Name | Type | Description | -| -------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -| baseType | `union Tenant \| Subscription \| ResourceGroup \| Location \| Extension` | The built-in parent of the resource, this can be "Tenant", "Subscription", "ResourceGroup", "Location", or "Extension" | +| Name | Type | Description | +| -------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| baseType | `"Tenant" \| "Subscription" \| "ResourceGroup" \| "Location" \| "Extension"` | The built-in parent of the resource, this can be "Tenant", "Subscription", "ResourceGroup", "Location", or "Extension" | ### `@resourceGroupResource` {#@Azure.ResourceManager.resourceGroupResource} @@ -365,7 +365,7 @@ Singleton resources only have a single instance with a fixed key name. See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type) ```typespec -@Azure.ResourceManager.singleton(keyValue?: valueof string | default) +@Azure.ResourceManager.singleton(keyValue?: valueof string | "default") ``` #### Target @@ -374,9 +374,9 @@ See more details on [different Azure Resource Manager resource type here.](https #### Parameters -| Name | Type | Description | -| -------- | --------------------------------- | -------------------------------------------------------------- | -| keyValue | `valueof union string \| default` | The name of the singleton resource. Default name is "default". | +| Name | Type | Description | +| -------- | ----------------------------- | -------------------------------------------------------------- | +| keyValue | `valueof string \| "default"` | The name of the singleton resource. Default name is "default". | ### `@subscriptionResource` {#@Azure.ResourceManager.subscriptionResource} @@ -435,6 +435,6 @@ This allows sharing Azure Resource Manager resource types across specifications #### Parameters -| Name | Type | Description | -| ---------- | ------------------- | ------------------------------------------------------------------------ | -| namespaces | `model Namespace[]` | The namespaces of Azure Resource Manager libraries used in this provider | +| Name | Type | Description | +| ---------- | ------------- | ------------------------------------------------------------------------ | +| namespaces | `Namespace[]` | The namespaces of Azure Resource Manager libraries used in this provider | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx index 4341332a23..8ebfa767e5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/index.mdx @@ -94,6 +94,7 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ArmResourceActionNoContentSync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionNoContentSync) - [`ArmResourceActionNoResponseContentAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionNoResponseContentAsync) - [`ArmResourceActionSync`](./interfaces.md#Azure.ResourceManager.ArmResourceActionSync) +- [`ArmResourceCheckExistence`](./interfaces.md#Azure.ResourceManager.ArmResourceCheckExistence) - [`ArmResourceCreateOrReplaceAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrReplaceAsync) - [`ArmResourceCreateOrReplaceSync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrReplaceSync) - [`ArmResourceCreateOrUpdateAsync`](./interfaces.md#Azure.ResourceManager.ArmResourceCreateOrUpdateAsync) @@ -130,6 +131,8 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager - [`ArmOperationStatus`](./data-types.md#Azure.ResourceManager.ArmOperationStatus) - [`ArmResourceCreatedResponse`](./data-types.md#Azure.ResourceManager.ArmResourceCreatedResponse) - [`ArmResourceCreatedSyncResponse`](./data-types.md#Azure.ResourceManager.ArmResourceCreatedSyncResponse) +- [`ArmResourceExistsResponse`](./data-types.md#Azure.ResourceManager.ArmResourceExistsResponse) +- [`ArmResourceNotFoundResponse`](./data-types.md#Azure.ResourceManager.ArmResourceNotFoundResponse) - [`ArmResourceUpdatedResponse`](./data-types.md#Azure.ResourceManager.ArmResourceUpdatedResponse) - [`ArmResponse`](./data-types.md#Azure.ResourceManager.ArmResponse) - [`CustomerManagedKeyEncryption`](./data-types.md#Azure.ResourceManager.CustomerManagedKeyEncryption) diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md index 588428796b..2347dd7fca 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/interfaces.md @@ -25,7 +25,7 @@ interface Azure.ResourceManager.ExtensionResourceCollectionOperations #### `ExtensionResourceCollectionOperations.list` {#Azure.ResourceManager.ExtensionResourceCollectionOperations.list} ```typespec -op Azure.ResourceManager.ExtensionResourceCollectionOperations.list(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceCollectionOperations.list(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ExtensionResourceInstanceOperations` {#Azure.ResourceManager.ExtensionResourceInstanceOperations} @@ -46,25 +46,25 @@ interface Azure.ResourceManager.ExtensionResourceInstanceOperations | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.get(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceInstanceOperations.createOrUpdate` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceInstanceOperations.update` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.update} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.update(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.update(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceInstanceOperations.delete` {#Azure.ResourceManager.ExtensionResourceInstanceOperations.delete} ```typespec -op Azure.ResourceManager.ExtensionResourceInstanceOperations.delete(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceInstanceOperations.delete(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ExtensionResourceOperations` {#Azure.ResourceManager.ExtensionResourceOperations} @@ -85,31 +85,31 @@ interface Azure.ResourceManager.ExtensionResourceOperations | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.get(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.createOrUpdate` {#Azure.ResourceManager.ExtensionResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.createOrUpdate(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.update` {#Azure.ResourceManager.ExtensionResourceOperations.update} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.update(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.update(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.delete` {#Azure.ResourceManager.ExtensionResourceOperations.delete} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.delete(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.delete(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `ExtensionResourceOperations.list` {#Azure.ResourceManager.ExtensionResourceOperations.list} ```typespec -op Azure.ResourceManager.ExtensionResourceOperations.list(apiVersion: string, resourceUri: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ExtensionResourceOperations.list(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `Operations` {#Azure.ResourceManager.Operations} @@ -128,7 +128,7 @@ interface Azure.ResourceManager.Operations<> List the operations for the provider ```typespec -op Azure.ResourceManager.Operations.list(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.Operations.list(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` ### `ProxyResourceOperations` {#Azure.ResourceManager.ProxyResourceOperations} @@ -155,25 +155,25 @@ interface Azure.ResourceManager.ProxyResourceOperations | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ProxyResourceOperations.createOrUpdate` {#Azure.ResourceManager.ProxyResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ProxyResourceOperations.delete` {#Azure.ResourceManager.ProxyResourceOperations.delete} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `ProxyResourceOperations.listByResourceGroup` {#Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ProxyResourceOperations.listByResourceGroup(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceCollectionOperations` {#Azure.ResourceManager.ResourceCollectionOperations} @@ -194,13 +194,13 @@ interface Azure.ResourceManager.ResourceCollectionOperations> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCollectionOperations.listByResourceGroup(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### `ResourceCollectionOperations.listBySubscription` {#Azure.ResourceManager.ResourceCollectionOperations.listBySubscription} ```typespec -op Azure.ResourceManager.ResourceCollectionOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCollectionOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceCreateAsync` {#Azure.ResourceManager.ResourceCreateAsync} @@ -221,7 +221,7 @@ interface Azure.ResourceManager.ResourceCreateAsync #### `ResourceCreateAsync.createOrUpdate` {#Azure.ResourceManager.ResourceCreateAsync.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceCreateAsync.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCreateAsync.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceCreateSync` {#Azure.ResourceManager.ResourceCreateSync} @@ -242,7 +242,7 @@ interface Azure.ResourceManager.ResourceCreateSync #### `ResourceCreateSync.createOrUpdate` {#Azure.ResourceManager.ResourceCreateSync.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceCreateSync.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedSyncResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceCreateSync.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedSyncResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceDeleteAsync` {#Azure.ResourceManager.ResourceDeleteAsync} @@ -261,7 +261,7 @@ interface Azure.ResourceManager.ResourceDeleteAsync #### `ResourceDeleteAsync.delete` {#Azure.ResourceManager.ResourceDeleteAsync.delete} ```typespec -op Azure.ResourceManager.ResourceDeleteAsync.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceDeleteAsync.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceDeleteSync` {#Azure.ResourceManager.ResourceDeleteSync} @@ -282,7 +282,7 @@ interface Azure.ResourceManager.ResourceDeleteSync #### `ResourceDeleteSync.delete` {#Azure.ResourceManager.ResourceDeleteSync.delete} ```typespec -op Azure.ResourceManager.ResourceDeleteSync.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceDeleteSync.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceDeleteWithoutOkAsync` {#Azure.ResourceManager.ResourceDeleteWithoutOkAsync} @@ -301,7 +301,7 @@ interface Azure.ResourceManager.ResourceDeleteWithoutOkAsync, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceDeleteWithoutOkAsync.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceInstanceOperations` {#Azure.ResourceManager.ResourceInstanceOperations} @@ -324,25 +324,25 @@ interface Azure.ResourceManager.ResourceInstanceOperations | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceInstanceOperations.createOrUpdate` {#Azure.ResourceManager.ResourceInstanceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceInstanceOperations.update` {#Azure.ResourceManager.ResourceInstanceOperations.update} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceInstanceOperations.delete` {#Azure.ResourceManager.ResourceInstanceOperations.delete} ```typespec -op Azure.ResourceManager.ResourceInstanceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceInstanceOperations.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceListByParent` {#Azure.ResourceManager.ResourceListByParent} @@ -365,7 +365,7 @@ interface Azure.ResourceManager.ResourceListByParent> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceListByParent.listByParent(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceListBySubscription` {#Azure.ResourceManager.ResourceListBySubscription} @@ -385,7 +385,7 @@ interface Azure.ResourceManager.ResourceListBySubscription #### `ResourceListBySubscription.listBySubscription` {#Azure.ResourceManager.ResourceListBySubscription.listBySubscription} ```typespec -op Azure.ResourceManager.ResourceListBySubscription.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceListBySubscription.listBySubscription(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceOperations` {#Azure.ResourceManager.ResourceOperations} @@ -405,37 +405,37 @@ interface Azure.ResourceManager.ResourceOperations | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.createOrUpdate` {#Azure.ResourceManager.ResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.ResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.update` {#Azure.ResourceManager.ResourceOperations.update} ```typespec -op Azure.ResourceManager.ResourceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.delete` {#Azure.ResourceManager.ResourceOperations.delete} ```typespec -op Azure.ResourceManager.ResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.listByResourceGroup` {#Azure.ResourceManager.ResourceOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.ResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.listByResourceGroup(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### `ResourceOperations.listBySubscription` {#Azure.ResourceManager.ResourceOperations.listBySubscription} ```typespec -op Azure.ResourceManager.ResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceRead` {#Azure.ResourceManager.ResourceRead} @@ -456,7 +456,7 @@ interface Azure.ResourceManager.ResourceRead #### `ResourceRead.get` {#Azure.ResourceManager.ResourceRead.get} ```typespec -op Azure.ResourceManager.ResourceRead.get(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceRead.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` ### `ResourceUpdateAsync` {#Azure.ResourceManager.ResourceUpdateAsync} @@ -476,7 +476,7 @@ interface Azure.ResourceManager.ResourceUpdateAsync): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceUpdateAsync.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse<"Resource update request accepted.", Azure.ResourceManager.ArmLroLocationHeader> | Azure.ResourceManager.ErrorResponse ``` ### `ResourceUpdateSync` {#Azure.ResourceManager.ResourceUpdateSync} @@ -498,7 +498,7 @@ interface Azure.ResourceManager.ResourceUpdateSync): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ResourceUpdateSync.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` ### `TenantResourceOperations` {#Azure.ResourceManager.TenantResourceOperations} @@ -525,31 +525,31 @@ interface Azure.ResourceManager.TenantResourceOperations #### `TenantResourceOperations.get` {#Azure.ResourceManager.TenantResourceOperations.get} ```typespec -op Azure.ResourceManager.TenantResourceOperations.get(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.get(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.createOrUpdate` {#Azure.ResourceManager.TenantResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.TenantResourceOperations.createOrUpdate(apiVersion: string, provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.createOrUpdate(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.update` {#Azure.ResourceManager.TenantResourceOperations.update} ```typespec -op Azure.ResourceManager.TenantResourceOperations.update(apiVersion: string, provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.update(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.delete` {#Azure.ResourceManager.TenantResourceOperations.delete} ```typespec -op Azure.ResourceManager.TenantResourceOperations.delete(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.delete(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `TenantResourceOperations.listByTenant` {#Azure.ResourceManager.TenantResourceOperations.listByTenant} ```typespec -op Azure.ResourceManager.TenantResourceOperations.listByTenant(apiVersion: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TenantResourceOperations.listByTenant(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `TrackedResourceOperations` {#Azure.ResourceManager.TrackedResourceOperations} @@ -574,37 +574,37 @@ interface Azure.ResourceManager.TrackedResourceOperations | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.createOrUpdate` {#Azure.ResourceManager.TrackedResourceOperations.createOrUpdate} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.createOrUpdate(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.update` {#Azure.ResourceManager.TrackedResourceOperations.update} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.update(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.delete` {#Azure.ResourceManager.TrackedResourceOperations.delete} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.delete(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.listByResourceGroup` {#Azure.ResourceManager.TrackedResourceOperations.listByResourceGroup} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.listByResourceGroup(provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.listByResourceGroup(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` #### `TrackedResourceOperations.listBySubscription` {#Azure.ResourceManager.TrackedResourceOperations.listBySubscription} ```typespec -op Azure.ResourceManager.TrackedResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.TrackedResourceOperations.listBySubscription(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse> | Azure.ResourceManager.ErrorResponse ``` ### `ArmCustomPatchAsync` {#Azure.ResourceManager.ArmCustomPatchAsync} @@ -612,7 +612,7 @@ op Azure.ResourceManager.TrackedResourceOperations.listBySubscription(apiVersion A long-running resource update using a custom PATCH payload (Asynchronous) ```typespec -op Azure.ResourceManager.ArmCustomPatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: PatchModel): Response | Error +op Azure.ResourceManager.ArmCustomPatchAsync(provider: "Microsoft.ThisWillBeReplaced", properties: PatchModel): Response | Error ``` #### Template Parameters @@ -632,7 +632,7 @@ op Azure.ResourceManager.ArmCustomPatchAsync(provider: Microsoft.ThisWillBeRepla A resource update using a custom PATCH payload (synchronous) ```typespec -op Azure.ResourceManager.ArmCustomPatchSync(provider: Microsoft.ThisWillBeReplaced, properties: PatchModel): Response | Error +op Azure.ResourceManager.ArmCustomPatchSync(provider: "Microsoft.ThisWillBeReplaced", properties: PatchModel): Response | Error ``` #### Template Parameters @@ -651,7 +651,7 @@ op Azure.ResourceManager.ArmCustomPatchSync(provider: Microsoft.ThisWillBeReplac A resource list operation, at the subscription scope ```typespec -op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced): Response | Error +op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -666,7 +666,7 @@ op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionI ### `ArmResourceActionAsync` {#Azure.ResourceManager.ArmResourceActionAsync} ```typespec -op Azure.ResourceManager.ArmResourceActionAsync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Response | Error +op Azure.ResourceManager.ArmResourceActionAsync(provider: "Microsoft.ThisWillBeReplaced", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Response | Error ``` #### Template Parameters @@ -686,7 +686,7 @@ op Azure.ResourceManager.ArmResourceActionAsync(provider: Microsoft.ThisWillBeRe A long-running resource action. ```typespec -op Azure.ResourceManager.ArmResourceActionAsyncBase(provider: Microsoft.ThisWillBeReplaced, body: Request): Response | Error +op Azure.ResourceManager.ArmResourceActionAsyncBase(provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Error ``` #### Template Parameters @@ -703,7 +703,7 @@ op Azure.ResourceManager.ArmResourceActionAsyncBase(provider: Microsoft.ThisWill ### `ArmResourceActionNoContentAsync` {#Azure.ResourceManager.ArmResourceActionNoContentAsync} ```typespec -op Azure.ResourceManager.ArmResourceActionNoContentAsync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmAcceptedLroResponse, never, never>, void, string>> | Azure.ResourceManager.ArmNoContentResponse | Error +op Azure.ResourceManager.ArmResourceActionNoContentAsync(provider: "Microsoft.ThisWillBeReplaced", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ArmNoContentResponse<"Action completed successfully."> | Error ``` #### Template Parameters @@ -722,7 +722,7 @@ op Azure.ResourceManager.ArmResourceActionNoContentAsync(provider: Microsoft.Thi A synchronous resource action that returns no content. ```typespec -op Azure.ResourceManager.ArmResourceActionNoContentSync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmNoContentResponse | Error +op Azure.ResourceManager.ArmResourceActionNoContentSync(provider: "Microsoft.ThisWillBeReplaced", body: Request): Azure.ResourceManager.ArmNoContentResponse<"Action completed successfully."> | Error ``` #### Template Parameters @@ -738,7 +738,7 @@ op Azure.ResourceManager.ArmResourceActionNoContentSync(provider: Microsoft.This ### `ArmResourceActionNoResponseContentAsync` {#Azure.ResourceManager.ArmResourceActionNoResponseContentAsync} ```typespec -op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(provider: Microsoft.ThisWillBeReplaced, body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Error +op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(provider: "Microsoft.ThisWillBeReplaced", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse | Error ``` #### Template Parameters @@ -757,7 +757,7 @@ op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(provider: Micro A synchronous resource action. ```typespec -op Azure.ResourceManager.ArmResourceActionSync(provider: Microsoft.ThisWillBeReplaced, body: Request): Response | Error +op Azure.ResourceManager.ArmResourceActionSync(provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Error ``` #### Template Parameters @@ -771,17 +771,35 @@ op Azure.ResourceManager.ArmResourceActionSync(provider: Microsoft.ThisWillBeRep | Parameters | Optional. Additional parameters after the path parameters | | Error | Optional. The error response, if non-standard. | +### `ArmResourceCheckExistence` {#Azure.ResourceManager.ArmResourceCheckExistence} + +Check a resource's existence via HEAD operation + +```typespec +op Azure.ResourceManager.ArmResourceCheckExistence(provider: "Microsoft.ThisWillBeReplaced"): Response | Error +``` + +#### Template Parameters + +| Name | Description | +| -------------- | --------------------------------------------------------- | +| Resource | the resource being checked | +| BaseParameters | Optional. Allows overriding the operation parameters | +| Parameters | Optional. Additional parameters after the path parameters | +| Response | Optional. The success response for the read operation | +| Error | Optional. The error response, if non-standard. | + ### `ArmResourceCreateOrReplaceAsync` {#Azure.ResourceManager.ArmResourceCreateOrReplaceAsync} ```typespec -op Azure.ResourceManager.ArmResourceCreateOrReplaceAsync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Error +op Azure.ResourceManager.ArmResourceCreateOrReplaceAsync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error ``` #### Template Parameters | Name | Description | | -------------- | ----------------------------------------------------------------------- | -| Resource | the resource being patched | +| Resource | the resource being created or replaced | | BaseParameters | Optional. Allows overriding the operation parameters | | LroHeaders | Optional. Allows overriding the lro headers returned on resource create | | Parameters | Optional. Additional parameters after the path parameters | @@ -793,14 +811,14 @@ op Azure.ResourceManager.ArmResourceCreateOrReplaceAsync(provider: Microsoft.Thi Synchronous PUT operation for Azure Resource Manager resources ```typespec -op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Response | Error +op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error ``` #### Template Parameters | Name | Description | | -------------- | --------------------------------------------------------------- | -| Resource | the resource being patched | +| Resource | the resource being created or replaced | | BaseParameters | Optional. Allows overriding the operation parameters | | Parameters | Optional. Additional parameters after the path parameters | | Response | Optional. The success response for the createOrUpdate operation | @@ -811,14 +829,14 @@ op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(provider: Microsoft.This A long-running resource CreateOrUpdate (PUT) ```typespec -op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse | Azure.ResourceManager.ArmResourceCreatedResponse | Error +op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error ``` #### Template Parameters | Name | Description | | -------------- | ----------------------------------------------------------------------- | -| Resource | the resource being patched | +| Resource | the resource being created or updated | | BaseParameters | Optional. Allows overriding the operation parameters | | LroHeaders | Optional. Allows overriding the lro headers returned on resource create | | Parameters | Optional. Additional parameters after the path parameters | @@ -830,14 +848,14 @@ op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(provider: Microsoft.This DEPRECATED: Please use ArmResourceCreateOrReplaceSync instead ```typespec -op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(provider: Microsoft.ThisWillBeReplaced, resource: Resource): Response | Error +op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error ``` #### Template Parameters | Name | Description | | -------------- | --------------------------------------------------------------- | -| Resource | the resource being patched | +| Resource | the resource being created or updated | | BaseParameters | Optional. Allows overriding the operation parameters | | Parameters | Optional. Additional parameters after the path parameters | | Response | Optional. The success response for the createOrUpdate operation | @@ -846,7 +864,7 @@ op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(provider: Microsoft.ThisW ### `ArmResourceDeleteAsync` {#Azure.ResourceManager.ArmResourceDeleteAsync} ```typespec -op Azure.ResourceManager.ArmResourceDeleteAsync(provider: Microsoft.ThisWillBeReplaced): Response | Error +op Azure.ResourceManager.ArmResourceDeleteAsync(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -863,7 +881,7 @@ op Azure.ResourceManager.ArmResourceDeleteAsync(provider: Microsoft.ThisWillBeRe ### `ArmResourceDeleteAsyncBase` {#Azure.ResourceManager.ArmResourceDeleteAsyncBase} ```typespec -op Azure.ResourceManager.ArmResourceDeleteAsyncBase(provider: Microsoft.ThisWillBeReplaced): Response | Error +op Azure.ResourceManager.ArmResourceDeleteAsyncBase(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -881,7 +899,7 @@ op Azure.ResourceManager.ArmResourceDeleteAsyncBase(provider: Microsoft.ThisWill Delete a resource synchronously ```typespec -op Azure.ResourceManager.ArmResourceDeleteSync(provider: Microsoft.ThisWillBeReplaced): Response | Error +op Azure.ResourceManager.ArmResourceDeleteSync(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -897,7 +915,7 @@ op Azure.ResourceManager.ArmResourceDeleteSync(provider: Microsoft.ThisWillBeRep ### `ArmResourceDeleteWithoutOkAsync` {#Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync} ```typespec -op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(provider: Microsoft.ThisWillBeReplaced): Response | Error +op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -916,7 +934,7 @@ op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(provider: Microsoft.Thi A resource list operation, with scope determined by BaseParameters ```typespec -op Azure.ResourceManager.ArmResourceListAtScope(provider: Microsoft.ThisWillBeReplaced): Response | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceListAtScope(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -934,7 +952,7 @@ op Azure.ResourceManager.ArmResourceListAtScope(provider: Microsoft.ThisWillBeRe A resource list operation, at the scope of the resource's parent ```typespec -op Azure.ResourceManager.ArmResourceListByParent(provider: Microsoft.ThisWillBeReplaced): Response | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceListByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters @@ -952,7 +970,7 @@ op Azure.ResourceManager.ArmResourceListByParent(provider: Microsoft.ThisWillBeR ### `ArmResourcePatchAsync` {#Azure.ResourceManager.ArmResourcePatchAsync} ```typespec -op Azure.ResourceManager.ArmResourcePatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourcePatchAsync(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters @@ -968,7 +986,7 @@ op Azure.ResourceManager.ArmResourcePatchAsync(provider: Microsoft.ThisWillBeRep ### `ArmResourcePatchSync` {#Azure.ResourceManager.ArmResourcePatchSync} ```typespec -op Azure.ResourceManager.ArmResourcePatchSync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourcePatchSync(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters @@ -985,14 +1003,14 @@ op Azure.ResourceManager.ArmResourcePatchSync(provider: Microsoft.ThisWillBeRepl A resource GET operation ```typespec -op Azure.ResourceManager.ArmResourceRead(provider: Microsoft.ThisWillBeReplaced): Response | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmResourceRead(provider: "Microsoft.ThisWillBeReplaced"): Response | Error ``` #### Template Parameters | Name | Description | | -------------- | --------------------------------------------------------- | -| Resource | the resource being patched | +| Resource | the resource being read | | BaseParameters | Optional. Allows overriding the operation parameters | | Parameters | Optional. Additional parameters after the path parameters | | Response | Optional. The success response for the read operation | @@ -1001,7 +1019,7 @@ op Azure.ResourceManager.ArmResourceRead(provider: Microsoft.ThisWillBeReplaced) ### `ArmTagsPatchAsync` {#Azure.ResourceManager.ArmTagsPatchAsync} ```typespec -op Azure.ResourceManager.ArmTagsPatchAsync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.TagsUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmTagsPatchAsync(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.TagsUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ArmAcceptedLroResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters @@ -1017,7 +1035,7 @@ op Azure.ResourceManager.ArmTagsPatchAsync(provider: Microsoft.ThisWillBeReplace ### `ArmTagsPatchSync` {#Azure.ResourceManager.ArmTagsPatchSync} ```typespec -op Azure.ResourceManager.ArmTagsPatchSync(provider: Microsoft.ThisWillBeReplaced, properties: Azure.ResourceManager.Foundations.TagsUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.ArmTagsPatchSync(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.TagsUpdateModel): Azure.ResourceManager.ArmResponse | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters @@ -1031,7 +1049,7 @@ op Azure.ResourceManager.ArmTagsPatchSync(provider: Microsoft.ThisWillBeReplaced ### `checkGlobalNameAvailability` {#Azure.ResourceManager.checkGlobalNameAvailability} ```typespec -op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced, body: Request): Response | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters @@ -1045,7 +1063,7 @@ op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscri ### `checkLocalNameAvailability` {#Azure.ResourceManager.checkLocalNameAvailability} ```typespec -op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: string, provider: Microsoft.ThisWillBeReplaced, location: string, body: Request): Response | Azure.ResourceManager.ErrorResponse +op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: string, provider: "Microsoft.ThisWillBeReplaced", location: string, body: Request): Response | Azure.ResourceManager.ErrorResponse ``` #### Template Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/enumerations/ResourceBaseType.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/enumerations/ResourceBaseType.md index a02192c942..f4e3c69b48 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/enumerations/ResourceBaseType.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/enumerations/ResourceBaseType.md @@ -5,7 +5,7 @@ title: "[E] ResourceBaseType" --- ## Enumeration Members -| Member | Value | +| Enumeration Member | Value | | :------ | :------ | | `Extension` | `"Extension"` | | `Location` | `"Location"` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md index 0f5dc269d0..ae2b999871 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/index.md @@ -25,6 +25,7 @@ title: "[P] JS API" ## Variables - [$lib](variables/$lib.md) +- [$linter](variables/$linter.md) - [namespace](variables/namespace.md) ## Functions diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmCommonTypeVersions.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmCommonTypeVersions.md index 576e6c42cc..b5d0e709d0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmCommonTypeVersions.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmCommonTypeVersions.md @@ -5,7 +5,7 @@ title: "[I] ArmCommonTypeVersions" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `allVersions` | `EnumMember`[] | - | -| `type` | `Enum` | - | +| Property | Type | +| :------ | :------ | +| `allVersions` | `EnumMember`[] | +| `type` | `Enum` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md index 94fec23a8c..09a09a304c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmLifecycleOperations.md @@ -5,9 +5,9 @@ title: "[I] ArmLifecycleOperations" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `createOrUpdate?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | -| `delete?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | -| `read?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | -| `update?` | [`ArmResourceOperation`](ArmResourceOperation.md) | - | +| Property | Type | +| :------ | :------ | +| `createOrUpdate?` | [`ArmResourceOperation`](ArmResourceOperation.md) | +| `delete?` | [`ArmResourceOperation`](ArmResourceOperation.md) | +| `read?` | [`ArmResourceOperation`](ArmResourceOperation.md) | +| `update?` | [`ArmResourceOperation`](ArmResourceOperation.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md index dcad67d6eb..8b85f69661 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetails.md @@ -11,13 +11,13 @@ Interface for ARM resource detail base. ## Properties -| Property | Type | Description | Inheritance | -| :------ | :------ | :------ | :------ | -| `armProviderNamespace` | `string` | - | [`ArmResourceDetailsBase.armProviderNamespace`](ArmResourceDetailsBase.md) | -| `collectionName` | `string` | - | [`ArmResourceDetailsBase.collectionName`](ArmResourceDetailsBase.md) | -| `keyName` | `string` | - | [`ArmResourceDetailsBase.keyName`](ArmResourceDetailsBase.md) | -| `kind` | [`ArmResourceKind`](../type-aliases/ArmResourceKind.md) | - | [`ArmResourceDetailsBase.kind`](ArmResourceDetailsBase.md) | -| `name` | `string` | - | [`ArmResourceDetailsBase.name`](ArmResourceDetailsBase.md) | -| `operations` | [`ArmResourceOperations`](ArmResourceOperations.md) | - | - | -| `resourceTypePath?` | `string` | - | - | -| `typespecType` | `Model` | - | [`ArmResourceDetailsBase.typespecType`](ArmResourceDetailsBase.md) | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `armProviderNamespace` | `string` | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`armProviderNamespace` | +| `collectionName` | `string` | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`collectionName` | +| `keyName` | `string` | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`keyName` | +| `kind` | [`ArmResourceKind`](../type-aliases/ArmResourceKind.md) | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`kind` | +| `name` | `string` | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`name` | +| `operations` | [`ArmResourceOperations`](ArmResourceOperations.md) | - | +| `resourceTypePath?` | `string` | - | +| `typespecType` | `Model` | [`ArmResourceDetailsBase`](ArmResourceDetailsBase.md).`typespecType` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetailsBase.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetailsBase.md index 72f0c8484d..67304a09f1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetailsBase.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceDetailsBase.md @@ -5,17 +5,17 @@ title: "[I] ArmResourceDetailsBase" --- Interface for ARM resource detail base. -## Extended By +## Extended by - [`ArmResourceDetails`](ArmResourceDetails.md) ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `armProviderNamespace` | `string` | - | -| `collectionName` | `string` | - | -| `keyName` | `string` | - | -| `kind` | [`ArmResourceKind`](../type-aliases/ArmResourceKind.md) | - | -| `name` | `string` | - | -| `typespecType` | `Model` | - | +| Property | Type | +| :------ | :------ | +| `armProviderNamespace` | `string` | +| `collectionName` | `string` | +| `keyName` | `string` | +| `kind` | [`ArmResourceKind`](../type-aliases/ArmResourceKind.md) | +| `name` | `string` | +| `typespecType` | `Model` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md index 1f141bc290..e58a16cb02 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperation.md @@ -9,11 +9,11 @@ title: "[I] ArmResourceOperation" ## Properties -| Property | Type | Description | Inheritance | -| :------ | :------ | :------ | :------ | -| `httpOperation` | `HttpOperation` | - | - | -| `kind` | [`ArmOperationKind`](../type-aliases/ArmOperationKind.md) | - | `ArmResourceOperationData.kind` | -| `name` | `string` | - | `ArmResourceOperationData.name` | -| `operation` | `Operation` | - | `ArmResourceOperationData.operation` | -| `operationGroup` | `string` | - | `ArmResourceOperationData.operationGroup` | -| `path` | `string` | - | - | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `httpOperation` | `HttpOperation` | - | +| `kind` | [`ArmOperationKind`](../type-aliases/ArmOperationKind.md) | `ArmResourceOperationData.kind` | +| `name` | `string` | `ArmResourceOperationData.name` | +| `operation` | `Operation` | `ArmResourceOperationData.operation` | +| `operationGroup` | `string` | `ArmResourceOperationData.operationGroup` | +| `path` | `string` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md index 16211cca82..e1e38ae927 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/interfaces/ArmResourceOperations.md @@ -5,8 +5,8 @@ title: "[I] ArmResourceOperations" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `actions` | `Object` | - | -| `lifecycle` | [`ArmLifecycleOperations`](ArmLifecycleOperations.md) | - | -| `lists` | `Object` | - | +| Property | Type | +| :------ | :------ | +| `actions` | `Object` | +| `lifecycle` | [`ArmLifecycleOperations`](ArmLifecycleOperations.md) | +| `lists` | `Object` | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md index a8c902c56e..4f77ad13db 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$lib.md @@ -9,33 +9,33 @@ const $lib: TypeSpecLibrary, never>; ## Type declaration -| Member | Type | Description | +| Member | Type | Value | | :------ | :------ | :------ | | `arm-common-types-incompatible-version` | `Object` | - | | `arm-common-types-incompatible-version.default` | `CallableMessage`<[`string`, `string`]\> | - | | `arm-resource-circular-ancestry` | `Object` | - | -| `arm-resource-circular-ancestry.default` | `string` | - | +| `arm-resource-circular-ancestry.default` | `string` | "There is a loop in the ancestry of this resource. Please ensure that the \`@parentResource\` decorator contains the correct parent resource, and that parentage contains no cycles." | | `arm-resource-duplicate-base-parameter` | `Object` | - | -| `arm-resource-duplicate-base-parameter.default` | `string` | - | +| `arm-resource-duplicate-base-parameter.default` | `string` | "Only one base parameter type is allowed per resource. Each resource may have only one of \`@parentResource\`, \`@resourceGroupResource\`, \`@tenantResource\`, \`@locationResource\`, or \`@subscriptionResource\` decorators." | | `arm-resource-invalid-base-type` | `Object` | - | -| `arm-resource-invalid-base-type.default` | `string` | - | +| `arm-resource-invalid-base-type.default` | `string` | "The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource." | | `arm-resource-missing` | `Object` | - | | `arm-resource-missing.default` | `CallableMessage`<[`string`]\> | - | | `arm-resource-missing-arm-namespace` | `Object` | - | -| `arm-resource-missing-arm-namespace.default` | `string` | - | +| `arm-resource-missing-arm-namespace.default` | `string` | "The @armProviderNamespace decorator must be used to define the ARM namespace of the service. This is best applied to the file-level namespace." | | `arm-resource-missing-name-key-decorator` | `Object` | - | -| `arm-resource-missing-name-key-decorator.default` | `string` | - | +| `arm-resource-missing-name-key-decorator.default` | `string` | "Resource type 'name' property must have a @key decorator which defines its key name." | | `arm-resource-missing-name-property` | `Object` | - | -| `arm-resource-missing-name-property.default` | `string` | - | +| `arm-resource-missing-name-property.default` | `string` | "Resource types must include a string property called 'name'." | | `arm-resource-missing-name-segment-decorator` | `Object` | - | -| `arm-resource-missing-name-segment-decorator.default` | `string` | - | +| `arm-resource-missing-name-segment-decorator.default` | `string` | "Resource type 'name' property must have a @segment decorator which defines its path fragment." | | `decorator-in-namespace` | `Object` | - | | `decorator-in-namespace.default` | `CallableMessage`<[`string`]\> | - | | `decorator-param-wrong-type` | `Object` | - | -| `decorator-param-wrong-type.armUpdateProviderNamespace` | `string` | - | +| `decorator-param-wrong-type.armUpdateProviderNamespace` | `string` | "The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter." | | `parent-type` | `Object` | - | | `parent-type.notResourceType` | `CallableMessage`<[`string`, `string`]\> | - | | `resource-without-path-and-segment` | `Object` | - | -| `resource-without-path-and-segment.default` | `string` | - | +| `resource-without-path-and-segment.default` | `string` | "Resource types must have a property with '@path\` and '@segment' decorators." | | `single-arm-provider` | `Object` | - | -| `single-arm-provider.default` | `string` | - | +| `single-arm-provider.default` | `string` | "Only one @armProviderNamespace can be declared in a typespec spec at once." | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$linter.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$linter.md new file mode 100644 index 0000000000..f8b4fc46f3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/js-api/variables/$linter.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $linter" + +--- +```ts +const $linter: LinterDefinition; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md index a202644a27..a4bc57b9d2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/reference/linter.md @@ -24,28 +24,31 @@ Available ruleSets: ## Rules -| Name | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment` | `@armResourceAction` should not be used with `@segment`. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property` | Warn about duplicate properties in resources. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator` | Each resource interface must have an @armResourceOperations decorator. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb` | Actions must be HTTP Post operations. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property` | Check for invalid resource envelope properties. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-version-format` | Check for valid versions. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-key-invalid-chars` | Arm resource key must contain only alphanumeric characters. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response` | [RPC 008]: PUT, GET, PATCH & LIST must return the same resource schema. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-patch` | Validate ARM PATCH operations. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-path-segment-invalid-chars` | Arm resource name must contain only alphanumeric characters. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state` | Check for properly configured provisioningState property. | -| `@azure-tools/typespec-azure-resource-manager/arm-common-types-version` | Specify the ARM common-types version using @armCommonTypesVersion. | -| `@azure-tools/typespec-azure-resource-manager/beyond-nesting-levels` | Tracked Resources must use 3 or fewer levels of nesting. | -| `@azure-tools/typespec-azure-resource-manager/arm-resource-operation` | Validate ARM Resource operations. | -| `@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation` | Check for resources that must have a delete operation. | -| `@azure-tools/typespec-azure-resource-manager/empty-updateable-properties` | Should have updateable properties. | -| `@azure-tools/typespec-azure-resource-manager/improper-subscription-list-operation` | Tenant and Extension resources should not define a list by subscription operation. | -| `@azure-tools/typespec-azure-resource-manager/no-response-body` | The body of 202 response should be empty. | -| `@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint` | Check for missing Operations interface. | -| `@azure-tools/typespec-azure-resource-manager/patch-envelope` | Patch envelope properties should match the resource properties. | -| `@azure-tools/typespec-azure-resource-manager/resource-name` | Check the resource name. | -| `@azure-tools/typespec-azure-resource-manager/retry-after` | Check if retry-after header appears in response body. | -| [`@azure-tools/typespec-azure-resource-manager/unsupported-type`](/libraries/azure-resource-manager/rules/unsupported-type.md) | Check for unsupported ARM types. | +| Name | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| [`@azure-tools/typespec-azure-resource-manager/arm-no-record`](/libraries/azure-resource-manager/rules/no-record.md) | Don't use Record types for ARM resources. | +| `@azure-tools/typespec-azure-resource-manager/arm-common-types-version` | Specify the ARM common-types version using @armCommonTypesVersion. | +| [`@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes`](/libraries/azure-resource-manager/rules/delete-operation-response-codes.md) | Ensure delete operations have the appropriate status codes. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment` | `@armResourceAction` should not be used with `@segment`. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property` | Warn about duplicate properties in resources. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property` | Check for invalid resource envelope properties. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-version-format` | Check for valid versions. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-key-invalid-chars` | Arm resource key must contain only alphanumeric characters. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response` | [RPC 008]: PUT, GET, PATCH & LIST must return the same resource schema. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-path-segment-invalid-chars` | Arm resource name must contain only alphanumeric characters. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state` | Check for properly configured provisioningState property. | +| `@azure-tools/typespec-azure-resource-manager/beyond-nesting-levels` | Tracked Resources must use 3 or fewer levels of nesting. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-operation` | Validate ARM Resource operations. | +| `@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation` | Check for resources that must have a delete operation. | +| `@azure-tools/typespec-azure-resource-manager/empty-updateable-properties` | Should have updateable properties. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator` | Each resource interface must have an @armResourceOperations decorator. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb` | Actions must be HTTP Post operations. | +| `@azure-tools/typespec-azure-resource-manager/improper-subscription-list-operation` | Tenant and Extension resources should not define a list by subscription operation. | +| [`@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers`](/libraries/azure-resource-manager/rules/missing-x-ms-identifiers.md) | Azure services should not use enums. | +| `@azure-tools/typespec-azure-resource-manager/no-response-body` | The body of 202 response should be empty. | +| `@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint` | Check for missing Operations interface. | +| `@azure-tools/typespec-azure-resource-manager/patch-envelope` | Patch envelope properties should match the resource properties. | +| `@azure-tools/typespec-azure-resource-manager/arm-resource-patch` | Validate ARM PATCH operations. | +| `@azure-tools/typespec-azure-resource-manager/resource-name` | Check the resource name. | +| `@azure-tools/typespec-azure-resource-manager/retry-after` | Check if retry-after header appears in response body. | +| [`@azure-tools/typespec-azure-resource-manager/unsupported-type`](/libraries/azure-resource-manager/rules/unsupported-type.md) | Check for unsupported ARM types. | diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/arm-resource-provisioning-state.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/arm-resource-provisioning-state.md new file mode 100644 index 0000000000..4dc92f48a6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/arm-resource-provisioning-state.md @@ -0,0 +1,30 @@ +--- +title: arm-resource-provisioning-state +--- + +```text title=- Full name- +@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state +``` + +`ProvisioningState` property of ARM resource must be: + +- optional +- readonly +- must at least contain `Succeeded`, `Canceled`, and `Canceled` + +#### ❌ Incorrect + +```tsp +model ResourceProperties { + provisioningState: ResourceProvisioningState; +} +``` + +#### ✅ Correct + +```tsp +model ResourceProperties { + @visibility("read") + provisioningState?: ResourceProvisioningState; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/delete-operation-response-codes.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/delete-operation-response-codes.md new file mode 100644 index 0000000000..9529ac2049 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/delete-operation-response-codes.md @@ -0,0 +1,55 @@ +--- +title: delete-operation-response-codes +--- + +```text title=- Full name- +@azure-tools/typespec-azure-resource-manager/delete-operation-response-codes +``` + +## Synchronous + +Synchronous delete operations should use the `ArmResourceDeleteSync` template. They must have 200, 204, default and no other responses. + +#### ❌ Incorrect + +```tsp +@armResourceOperations +interface Employees { + @armResourceDelete(Employee) + delete(...ApiVersionParameter): { + @statusCode _: 200; + result: boolean; + }; +} +``` + +#### ✅ Correct + +```tsp +@armResourceOperations +interface Employees { + delete is ArmResourceDeleteSync; +} +``` + +## Asynchronous + +Long-running (LRO) delete operations should use the `ArmResourceDeleteWithoutOkAsync` template. They must have 202, 204, default, and no other responses. + +#### ❌ Incorrect + +```tsp +@armResourceOperations +interface Employees { + delete is ArmResourceDeleteAsync; +} +``` + +#### ✅ Correct + +```tsp +@armResourceOperations +interface Employees { + delete is ArmResourceDeleteWithoutOkAsync; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/missing-x-ms-identifiers.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/missing-x-ms-identifiers.md new file mode 100644 index 0000000000..c07c53dc2c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/missing-x-ms-identifiers.md @@ -0,0 +1,31 @@ +--- +title: missing-x-ms-identifiers +--- + +```text title=- Full name- +@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers +``` + +Check that array properties have `x-ms-identifiers` specified with `@OpenAPI.extension` + +#### ❌ Incorrect + +```tsp +model Address [] { + city: string; + street: string; +} + +model ResourceProperties { + array: Address[] +} +``` + +#### ✅ Correct + +```tsp +model ResourceProperties { + @OpenAPI.extension("x-ms-identifiers", ["city", "street"]) + array: Address[]; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-record.md b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-record.md new file mode 100644 index 0000000000..b917f154e8 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/azure-resource-manager/rules/no-record.md @@ -0,0 +1,67 @@ +--- +title: no-record +--- + +```text title=- Full name- +@azure-tools/typespec-azure-resource-manager/no-record +``` + +ARM requires Resource provider teams to define types explicitly. This is to ensure good customer experience in terms of the discoverability of concrete type definitions. + +#### ❌ Incorrect + +```tsp +model Address { + address: Record; + city: string; + state: string; +} +``` + +#### ✅ Correct + +```tsp +model Address { + street: string; + city: string; + state: string; + country: string; + postalCode: string; +} +``` + +#### ❌ Incorrect + +```tsp +model Address is Record; +``` + +#### ✅ Correct + +```tsp +model Address { + street: string; + city: string; + state: string; + country: string; + postalCode: string; +} +``` + +#### ❌ Incorrect + +```tsp +model Address extends Record {} +``` + +#### ✅ Correct + +```tsp +model Address { + street: string; + city: string; + state: string; + country: string; + postalCode: string; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md index 0e32fe7902..acbd7a8437 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/decorators.md @@ -10,7 +10,17 @@ toc_max_heading_level: 3 ### `@access` {#@Azure.ClientGenerator.Core.access} -Set access for operations, models and enums. All models that are only used in operations with access "internal" will be implicitly set to access "internal". +Set explicit access for operations, models and enums. +When setting access for models, +the access info wll not be propagated to models' properties, base models or sub models. +When setting access for an operation, +it will influence the access info for models/enums that are used by this operation. +Models/enums that are used in any operations with `@access(Access.public)` will be implicitly set to access "public" +Models/enums that are only used in operations with `@access(Access.internal)` will be implicitly set to access "internal". +This influence will be propagated to models' properties, parent models, discriminated sub models. +But this influence will be override by `@usage` decorator on models/enums directly. +If an operation/model/enum has no `@access` decorator and is not influenced by any operation with `@access` decorator, +the access result is undefined. ```typespec @Azure.ClientGenerator.Core.access(value: EnumMember, scope?: valueof string) @@ -18,26 +28,125 @@ Set access for operations, models and enums. All models that are only used in op #### Target -`union Model | Operation | Enum` +`Model | Operation | Enum` #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| value | `EnumMember` | The access info you want to set for this model or operation. | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| value | `EnumMember` | The access info you want to set for this model or operation. | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples +##### Set access + ```typespec +// Access.internal @access(Access.internal) model ModelToHide { prop: valueof string } +// Access.internal @access(Access.internal) op test: void; ``` +##### Access propagation + +```typespec +// Access.internal +@discriminator("kind") +model Fish { + age: int32; +} + +// Access.internal +@discriminator("sharktype") +model Shark extends Fish { + kind: "shark"; + origin: Origin; +} + +// Access.internal +model Salmon extends Fish { + kind: "salmon"; +} + +// Access.internal +model SawShark extends Shark { + sharktype: "saw"; +} + +// Access.internal +model Origin { + country: string; + city: string; + manufacture: string; +} + +// Access.internal +@get +@access(Access.internal) +op getModel(): Fish; +``` + +##### Access influence from operation + +```typespec +// Access.internal +model Test1 {} + +// Access.internal +@access(Access.internal) +@route("/func1") +op func1(@body body: Test1): void; + +// undefined +model Test2 {} + +// undefined +@route("/func2") +op func2(@body body: Test2): void; + +// Access.public +model Test3 {} + +// Access.public +@access(Access.public) +@route("/func3") +op func3(@body body: Test3): void; + +// undefined +model Test4 {} + +// Access.internal +@access(Access.internal) +@route("/func4") +op func4(@body body: Test4): void; + +// undefined +@route("/func5") +op func5(@body body: Test4): void; + +// Access.public +model Test5 {} + +// Access.internal +@access(Access.internal) +@route("/func6") +op func6(@body body: Test5): void; + +// undefined +@route("/func7") +op func7(@body body: Test5): void; + +// Access.public +@access(Access.public) +@route("/func8") +op func8(@body body: Test5): void; +``` + ### `@client` {#@Azure.ClientGenerator.Core.client} Create a ClientGenerator.Core client out of a namespace or interface @@ -48,14 +157,14 @@ Create a ClientGenerator.Core client out of a namespace or interface #### Target -`union Namespace | Interface` +`Namespace | Interface` #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| value | `model {}` | Optional configuration for the service. | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| value | `{}` | Optional configuration for the service. | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -96,7 +205,7 @@ Can be used to explain the client type that the current TYPESPEC type should map to. ```typespec -@Azure.ClientGenerator.Core.clientFormat(value: valueof unixtime | iso8601 | rfc1123 | seconds) +@Azure.ClientGenerator.Core.clientFormat(value: valueof "unixtime" | "iso8601" | "rfc1123" | "seconds") ``` #### Target @@ -105,9 +214,9 @@ type should map to. #### Parameters -| Name | Type | Description | -| ----- | --------------------------------------------------------- | --------------------------- | -| value | `valueof union unixtime \| iso8601 \| rfc1123 \| seconds` | The client format to apply. | +| Name | Type | Description | +| ----- | ----------------------------------------------------------- | --------------------------- | +| value | `valueof "unixtime" \| "iso8601" \| "rfc1123" \| "seconds"` | The client format to apply. | #### Examples @@ -128,14 +237,14 @@ Changes the name of a method, parameter, property, or model generated in the cli #### Target -`(intrinsic) unknown` +`unknown` #### Parameters -| Name | Type | Description | -| ------ | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| rename | `valueof scalar string` | The rename you want applied to the object | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ------ | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| rename | `valueof string` | The rename you want applied to the object | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -166,10 +275,10 @@ Whether you want to generate an operation as a convenient operation. #### Parameters -| Name | Type | Description | -| ----- | ------------------------ | ------------------------------------------------------------------------------------------------------------- | -| value | `valueof scalar boolean` | Whether to generate the operation as convenience method or not. | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ----------------- | ------------------------------------------------------------------------------------------------------------- | +| value | `valueof boolean` | Whether to generate the operation as convenience method or not. | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -193,9 +302,9 @@ all models that are included in operations. #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -220,9 +329,9 @@ Set whether a model property should be flattened or not. #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -249,9 +358,9 @@ all models that are included in operations. #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -277,9 +386,9 @@ meaning it should not be exposed to end SDK users #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -298,13 +407,13 @@ Create a ClientGenerator.Core operation group out of a namespace or interface #### Target -`union Namespace | Interface` +`Namespace | Interface` #### Parameters -| Name | Type | Description | -| ----- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ---------------- | ------------------------------------------------------------------------------------------------------------- | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -327,10 +436,10 @@ Whether you want to generate an operation as a protocol operation. #### Parameters -| Name | Type | Description | -| ----- | ------------------------ | ------------------------------------------------------------------------------------------------------------- | -| value | `valueof scalar boolean` | Whether to generate the operation as protocol or not. | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | ----------------- | ------------------------------------------------------------------------------------------------------------- | +| value | `valueof boolean` | Whether to generate the operation as protocol or not. | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples @@ -341,8 +450,18 @@ op test: void; ### `@usage` {#@Azure.ClientGenerator.Core.usage} -Expand usage for models/enums. A model's default usage info is always calculated by the operations that use it. -You could use this decorator to expand the default usage info. (e.g. append Usage.input by +Expand usage for models/enums. +A model/enum's default usage info is always calculated by the operations that use it. +You could use this decorator to expand the default usage info. +For example, with operation definition `op test(): OutputModel`, +the model `OutputModel` has default usage `Usage.output`. +After adding decorator `@@usage(OutputModel, Usage.input)`, +the final usage result for `OutputModel` is `Usage.input | Usage.output`. +The calculation of default usage info for models will be propagated to models' properties, +parent models, discriminated sub models. +But the expanded usage from `@usage` decorator will not be propagated. +If you want to do any customization for the usage of a model, +you need to take care of all related models/enums. ```typespec @Azure.ClientGenerator.Core.usage(value: EnumMember | Union, scope?: valueof string) @@ -350,20 +469,63 @@ You could use this decorator to expand the default usage info. (e.g. append Usag #### Target -`union Model | Enum` +`Model | Enum` #### Parameters -| Name | Type | Description | -| ----- | --------------------------- | ------------------------------------------------------------------------------------------------------------- | -| value | `union EnumMember \| Union` | The usage info you want to set for this model. | -| scope | `valueof scalar string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | +| Name | Type | Description | +| ----- | --------------------- | ------------------------------------------------------------------------------------------------------------- | +| value | `EnumMember \| Union` | The usage info you want to set for this model. | +| scope | `valueof string` | The language scope you want this decorator to apply to. If not specified, will apply to all language emitters | #### Examples +##### Expand usage for model + ```typespec -@usage(Usage.input | Usage.output) -model InputAndOutPutModel { +op test(): OutputModel; + +// usage result for `OutputModel` is `Usage.input | Usage.output` +@usage(Usage.input) +model OutputModel { prop: string; } ``` + +##### Propagation of usage + +```typespec +// Usage.output +@discriminator("kind") +model Fish { + age: int32; +} + +// Usage.input | Usage.output +@discriminator("sharktype") +@usage(Usage.input) +model Shark extends Fish { + kind: "shark"; + origin: Origin; +} + +// Usage.output +model Salmon extends Fish { + kind: "salmon"; +} + +// Usage.output +model SawShark extends Shark { + sharktype: "saw"; +} + +// Usage.output +model Origin { + country: string; + city: string; + manufacture: string; +} + +@get +op getModel(): Fish; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md index f01699a739..54ee96cd69 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createDiagnostic.md @@ -9,7 +9,7 @@ createDiagnostic(diag): Diagnostic ## Type parameters -| Parameter | +| Type parameter | | :------ | | `C` extends \| `"client-name"` @@ -26,7 +26,9 @@ createDiagnostic(diag): Diagnostic \| `"discriminator-not-constant"` \| `"discriminator-not-string"` \| `"wrong-client-decorator"` - \| `"encoding-multipart-bytes"` | + \| `"encoding-multipart-bytes"` + \| `"unsupported-kind"` + \| `"multiple-services"` | | `M` extends `string` \| `number` \| `symbol` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md index 363718b8b6..901af3f2a5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/createSdkContext.md @@ -9,7 +9,7 @@ createSdkContext(context, emitterName?): SdkContext ## Type parameters -| Parameter | Value | +| Type parameter | Value | | :------ | :------ | | `TOptions` extends `Record`<`string`, `any`\> | [`SdkEmitterOptions`](../interfaces/SdkEmitterOptions.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccess.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccess.md index d016e37eec..d213ffcebf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccess.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccess.md @@ -11,7 +11,7 @@ getAccess(context, entity): AccessFlags | undefined | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Model` \| `Enum` \| `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccessOverride.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccessOverride.md index f9e0db1ac2..2d35072664 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccessOverride.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAccessOverride.md @@ -11,7 +11,7 @@ getAccessOverride(context, entity): AccessFlags | undefined | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Model` \| `Enum` \| `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModels.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModels.md index 0127884f56..042c7d190c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModels.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModels.md @@ -11,7 +11,7 @@ getAllModels(context, options): (SdkModelType | SdkEnumType)[] | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `options` | `GetAllModelsOptions` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModelsWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModelsWithDiagnostics.md new file mode 100644 index 0000000000..e759190f47 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getAllModelsWithDiagnostics.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getAllModelsWithDiagnostics" + +--- +```ts +getAllModelsWithDiagnostics(context, options): [(SdkModelType | SdkEnumType)[], readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `options` | `GetAllModelsOptions` | + +## Returns + +[([`SdkModelType`](../interfaces/SdkModelType.md) \| [`SdkEnumType`](../interfaces/SdkEnumType.md))[], readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md index 59731c5dc2..a7adf43680 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClient.md @@ -13,7 +13,7 @@ Return the client object for the given namespace or interface, or undefined if t | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | | `type` | `Interface` \| `Namespace` | Type to check | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientFormat.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientFormat.md index 2705c764ee..c4957b282e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientFormat.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientFormat.md @@ -14,7 +14,7 @@ on whether additional serialization information is provided or needed | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | the Sdk Context | +| `context` | `TCGCContext` | the Sdk Context | | `entity` | `ModelProperty` | the entity whose client format we are going to get | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md index 124d5873f3..89551ac6a9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNameOverride.md @@ -11,7 +11,7 @@ getClientNameOverride(context, entity): string | undefined | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNamespaceString.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNamespaceString.md index ff2c6b9534..04af6e0fe1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNamespaceString.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientNamespaceString.md @@ -14,7 +14,7 @@ that value as our namespace. Otherwise, we default to the TypeSpec service names | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | | +| `context` | `TCGCContext` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientType.md index 84d5cfa28a..e9ac25de95 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientType.md @@ -14,7 +14,7 @@ getClientType( | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Type` | | `operation`? | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientTypeWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientTypeWithDiagnostics.md new file mode 100644 index 0000000000..550849a916 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getClientTypeWithDiagnostics.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getClientTypeWithDiagnostics" + +--- +```ts +getClientTypeWithDiagnostics( + context, + type, + operation?): [SdkType, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `type` | `Type` | +| `operation`? | `Operation` | + +## Returns + +[[`SdkType`](../type-aliases/SdkType.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getCrossLanguagePackageId.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getCrossLanguagePackageId.md new file mode 100644 index 0000000000..6049dab73f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getCrossLanguagePackageId.md @@ -0,0 +1,20 @@ +--- +jsApi: true +title: "[F] getCrossLanguagePackageId" + +--- +```ts +getCrossLanguagePackageId(context): [string, readonly Diagnostic[]] +``` + +Helper function return the cross langauge package id for a package + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | + +## Returns + +[`string`, readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDefaultApiVersion.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDefaultApiVersion.md index ac09f6ec26..eb2c38c3c5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDefaultApiVersion.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDefaultApiVersion.md @@ -13,7 +13,7 @@ Return the default api version for a versioned service. Will return undefined if | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | - | +| `context` | `TCGCContext` | - | | `serviceNamespace` | `Namespace` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDocHelper.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDocHelper.md index 465436a812..af8d5dfd5e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDocHelper.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getDocHelper.md @@ -11,7 +11,7 @@ getDocHelper(context, type): DocWrapper | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEffectivePayloadType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEffectivePayloadType.md index 2c3d87f502..5ec0b83db5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEffectivePayloadType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEffectivePayloadType.md @@ -15,7 +15,7 @@ Otherwise the given type is returned unchanged. | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | | +| `context` | `TCGCContext` | | | `type` | `Model` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEmitterTargetName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEmitterTargetName.md index ee0d35614d..9c0b1db1ca 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEmitterTargetName.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getEmitterTargetName.md @@ -11,7 +11,7 @@ getEmitterTargetName(context): string | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getGeneratedName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getGeneratedName.md index 23e25c0aed..a01f009b82 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getGeneratedName.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getGeneratedName.md @@ -16,7 +16,7 @@ Create a name for anonymous model | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | | +| `context` | `TCGCContext` | | | `type` | `Model` \| `Union` | | | `operation`? | `Operation` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md index 9671a231f3..c90c2d33ee 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getLibraryName.md @@ -20,18 +20,8 @@ Returns name in the following order of priority | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | | -| `type` | `Object` | | -| `type.instantiationParameters`? | `Type`[] | - | -| `type.isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `type.kind` | \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"StringTemplate"` \| `"StringTemplateSpan"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"` | - | -| `type.name`? | `string` | - | -| `type.node`? | \| `TypeSpecScriptNode` \| `JsSourceFileNode` \| `JsNamespaceDeclarationNode` \| `TemplateArgumentNode` \| `TemplateParameterDeclarationNode` \| `ProjectionParameterDeclarationNode` \| `ProjectionLambdaParameterDeclarationNode` \| `ModelPropertyNode` \| `UnionVariantNode` \| `OperationStatementNode` \| `OperationSignatureDeclarationNode` \| `OperationSignatureReferenceNode` \| `EnumMemberNode` \| `EnumSpreadMemberNode` \| `ModelSpreadPropertyNode` \| `DecoratorExpressionNode` \| `DirectiveExpressionNode` \| `ImportStatementNode` \| `ModelStatementNode` \| `ScalarStatementNode` \| `NamespaceStatementNode` \| `InterfaceStatementNode` \| `UnionStatementNode` \| `UsingStatementNode` \| `EnumStatementNode` \| `AliasStatementNode` \| `DecoratorDeclarationStatementNode` \| `FunctionDeclarationStatementNode` \| `AugmentDecoratorStatementNode` \| `EmptyStatementNode` \| `InvalidStatementNode` \| `ProjectionStatementNode` \| `ArrayExpressionNode` \| `MemberExpressionNode` \| `ModelExpressionNode` \| `TupleExpressionNode` \| `UnionExpressionNode` \| `IntersectionExpressionNode` \| `TypeReferenceNode` \| `ValueOfExpressionNode` \| `StringLiteralNode` \| `NumericLiteralNode` \| `BooleanLiteralNode` \| `StringTemplateExpressionNode` \| `VoidKeywordNode` \| `NeverKeywordNode` \| `AnyKeywordNode` \| `FunctionParameterNode` \| `StringTemplateSpanNode` \| `StringTemplateHeadNode` \| `StringTemplateMiddleNode` \| `StringTemplateTailNode` \| `ExternKeywordNode` \| `DocNode` \| `DocTextNode` \| `DocReturnsTagNode` \| `DocErrorsTagNode` \| `DocParamTagNode` \| `DocTemplateTagNode` \| `DocUnknownTagNode` \| `ProjectionExpressionStatementNode` \| `ProjectionLogicalExpressionNode` \| `ProjectionRelationalExpressionNode` \| `ProjectionEqualityExpressionNode` \| `ProjectionUnaryExpressionNode` \| `ProjectionArithmeticExpressionNode` \| `ProjectionCallExpressionNode` \| `ProjectionMemberExpressionNode` \| `ProjectionDecoratorReferenceExpressionNode` \| `ProjectionTupleExpressionNode` \| `ProjectionModelExpressionNode` \| `ProjectionIfExpressionNode` \| `ProjectionBlockExpressionNode` \| `ProjectionLambdaExpressionNode` \| `IdentifierNode` \| `ReturnExpressionNode` \| `ProjectionModelSelectorNode` \| `ProjectionModelPropertySelectorNode` \| `ProjectionInterfaceSelectorNode` \| `ProjectionOperationSelectorNode` \| `ProjectionEnumSelectorNode` \| `ProjectionEnumMemberSelectorNode` \| `ProjectionUnionSelectorNode` \| `ProjectionUnionVariantSelectorNode` \| `ProjectionModelPropertyNode` \| `ProjectionModelSpreadPropertyNode` \| `ProjectionNode` | - | -| `type.projectionBase`? | `Type` | - | -| `type.projectionSource`? | `Type` | - | -| `type.projector`? | `Projector` | - | -| `type.projections` | - | -| `type.projectionsByName` | - | +| `context` | `TCGCContext` | | +| `type` | `Type` & `Object` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getOperationGroup.md index dcd86c3d4d..5ec812d2a6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getOperationGroup.md @@ -13,7 +13,7 @@ Return the operation group object for the given namespace or interface or undefi | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | | `type` | `Interface` \| `Namespace` | Type to check | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md index e5cadca760..26ae7e5ef6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getPropertyNames.md @@ -13,7 +13,7 @@ Get the library and wire name of a model property. Takes | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | | +| `context` | `TCGCContext` | | | `property` | `ModelProperty` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDict.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDict.md index 7704547d0c..1dc719502b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDict.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDict.md @@ -14,7 +14,7 @@ getSdkArrayOrDict( | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Model` | | `operation`? | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDictWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDictWithDiagnostics.md new file mode 100644 index 0000000000..66ad63f7c9 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkArrayOrDictWithDiagnostics.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getSdkArrayOrDictWithDiagnostics" + +--- +```ts +getSdkArrayOrDictWithDiagnostics( + context, + type, + operation?): [SdkDictionaryType | SdkArrayType | undefined, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `type` | `Model` | +| `operation`? | `Operation` | + +## Returns + +[[`SdkDictionaryType`](../interfaces/SdkDictionaryType.md) \| [`SdkArrayType`](../interfaces/SdkArrayType.md) \| `undefined`, readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkBuiltInType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkBuiltInType.md index 84d23cb6aa..c716b1feb4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkBuiltInType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkBuiltInType.md @@ -13,8 +13,8 @@ Get the sdk built in type for a given typespec type | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | the sdk context | -| `type` | \| `StringLiteral` \| `NumericLiteral` \| `BooleanLiteral` \| `Scalar` \| `IntrinsicType` | the typespec type | +| `context` | `TCGCContext` | the sdk context | +| `type` | \| `StringLiteral` \| `NumericLiteral` \| `BooleanLiteral` \| `Scalar` \| `IntrinsicType` | the typespec type | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkConstant.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkConstant.md index b10724610a..864c6b2b79 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkConstant.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkConstant.md @@ -11,7 +11,7 @@ getSdkConstant(context, type): SdkConstantType | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `StringLiteral` \| `NumericLiteral` \| `BooleanLiteral` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDatetimeType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDatetimeType.md deleted file mode 100644 index c5a974363c..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDatetimeType.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[F] getSdkDatetimeType" - ---- -```ts -getSdkDatetimeType(context, type): SdkDatetimeType -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | -| `type` | `Scalar` | - -## Returns - -[`SdkDatetimeType`](../interfaces/SdkDatetimeType.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDurationType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDurationType.md index fe70f51102..c6fd3010a5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDurationType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkDurationType.md @@ -11,7 +11,7 @@ getSdkDurationType(context, type): SdkDurationType | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Scalar` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnum.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnum.md index bd78dda865..34899a7ac4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnum.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnum.md @@ -14,7 +14,7 @@ getSdkEnum( | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Enum` | | `operation`? | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnumValue.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnumValue.md index 5e2d1f7167..299cf62e10 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnumValue.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkEnumValue.md @@ -14,7 +14,7 @@ getSdkEnumValue( | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `enumType` | [`SdkEnumType`](../interfaces/SdkEnumType.md) | | `type` | `EnumMember` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModel.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModel.md index 4fe3c4c984..7c6e8be4e1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModel.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModel.md @@ -14,7 +14,7 @@ getSdkModel( | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Model` | | `operation`? | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModelWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModelWithDiagnostics.md new file mode 100644 index 0000000000..dd608939f5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkModelWithDiagnostics.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getSdkModelWithDiagnostics" + +--- +```ts +getSdkModelWithDiagnostics( + context, + type, + operation?): [SdkModelType, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `type` | `Model` | +| `operation`? | `Operation` | + +## Returns + +[[`SdkModelType`](../interfaces/SdkModelType.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTuple.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTuple.md index 5818367df1..375a8fa991 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTuple.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTuple.md @@ -14,7 +14,7 @@ getSdkTuple( | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Tuple` | | `operation`? | `Operation` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTupleWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTupleWithDiagnostics.md new file mode 100644 index 0000000000..b7a156ef8e --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTupleWithDiagnostics.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getSdkTupleWithDiagnostics" + +--- +```ts +getSdkTupleWithDiagnostics( + context, + type, + operation?): [SdkTupleType, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `type` | `Tuple` | +| `operation`? | `Operation` | + +## Returns + +[[`SdkTupleType`](../interfaces/SdkTupleType.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTypeBaseHelper.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTypeBaseHelper.md index e5e49cc556..7c17d4cca2 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTypeBaseHelper.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkTypeBaseHelper.md @@ -14,7 +14,7 @@ Helper function to return default values for nullable, encode etc ## Type parameters -| Parameter | +| Type parameter | | :------ | | `TKind` | @@ -22,7 +22,7 @@ Helper function to return default values for nullable, encode etc | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | - | +| `context` | `TCGCContext` | - | | `type` | `string` \| `Type` | | | `kind` | `TKind` | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnion.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnion.md index dcc8390652..0de2624786 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnion.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnion.md @@ -7,17 +7,17 @@ title: "[F] getSdkUnion" getSdkUnion( context, type, - operation?): SdkType | undefined + operation?): SdkType ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Union` | | `operation`? | `Operation` | ## Returns -[`SdkType`](../type-aliases/SdkType.md) \| `undefined` +[`SdkType`](../type-aliases/SdkType.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnionWithDiagnostics.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnionWithDiagnostics.md new file mode 100644 index 0000000000..dc970a9252 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getSdkUnionWithDiagnostics.md @@ -0,0 +1,23 @@ +--- +jsApi: true +title: "[F] getSdkUnionWithDiagnostics" + +--- +```ts +getSdkUnionWithDiagnostics( + context, + type, + operation?): [SdkType, readonly Diagnostic[]] +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `type` | `Union` | +| `operation`? | `Operation` | + +## Returns + +[[`SdkType`](../type-aliases/SdkType.md), readonly `Diagnostic`[]] diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsage.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsage.md index 0f5ac11df2..61da1a97a9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsage.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsage.md @@ -11,7 +11,7 @@ getUsage(context, entity): UsageFlags | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Model` \| `Enum` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsageOverride.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsageOverride.md index ce002b3b88..8f0e73a87a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsageOverride.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getUsageOverride.md @@ -11,7 +11,7 @@ getUsageOverride(context, entity): UsageFlags | undefined | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Model` \| `Enum` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md index d5cbf9e231..a9e5244a8f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/getWireName.md @@ -9,20 +9,10 @@ getWireName(context, type): string ## Parameters -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | - | -| `type` | `Object` | - | -| `type.instantiationParameters`? | `Type`[] | - | -| `type.isFinished` | `boolean` | Reflect if a type has been finished(Decorators have been called).
There is multiple reasons a type might not be finished:
- a template declaration will not
- a template instance that argument that are still template parameters
- a template instance that is only partially instantiated(like a templated operation inside a templated interface) | -| `type.kind` | \| `"String"` \| `"Number"` \| `"Boolean"` \| `"Model"` \| `"ModelProperty"` \| `"Scalar"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` \| `"TemplateParameter"` \| `"Namespace"` \| `"Operation"` \| `"StringTemplate"` \| `"StringTemplateSpan"` \| `"Tuple"` \| `"Union"` \| `"UnionVariant"` \| `"Intrinsic"` \| `"Function"` \| `"Decorator"` \| `"FunctionParameter"` \| `"Object"` \| `"Projection"` | - | -| `type.name` | `string` | - | -| `type.node`? | \| `TypeSpecScriptNode` \| `JsSourceFileNode` \| `JsNamespaceDeclarationNode` \| `TemplateArgumentNode` \| `TemplateParameterDeclarationNode` \| `ProjectionParameterDeclarationNode` \| `ProjectionLambdaParameterDeclarationNode` \| `ModelPropertyNode` \| `UnionVariantNode` \| `OperationStatementNode` \| `OperationSignatureDeclarationNode` \| `OperationSignatureReferenceNode` \| `EnumMemberNode` \| `EnumSpreadMemberNode` \| `ModelSpreadPropertyNode` \| `DecoratorExpressionNode` \| `DirectiveExpressionNode` \| `ImportStatementNode` \| `ModelStatementNode` \| `ScalarStatementNode` \| `NamespaceStatementNode` \| `InterfaceStatementNode` \| `UnionStatementNode` \| `UsingStatementNode` \| `EnumStatementNode` \| `AliasStatementNode` \| `DecoratorDeclarationStatementNode` \| `FunctionDeclarationStatementNode` \| `AugmentDecoratorStatementNode` \| `EmptyStatementNode` \| `InvalidStatementNode` \| `ProjectionStatementNode` \| `ArrayExpressionNode` \| `MemberExpressionNode` \| `ModelExpressionNode` \| `TupleExpressionNode` \| `UnionExpressionNode` \| `IntersectionExpressionNode` \| `TypeReferenceNode` \| `ValueOfExpressionNode` \| `StringLiteralNode` \| `NumericLiteralNode` \| `BooleanLiteralNode` \| `StringTemplateExpressionNode` \| `VoidKeywordNode` \| `NeverKeywordNode` \| `AnyKeywordNode` \| `FunctionParameterNode` \| `StringTemplateSpanNode` \| `StringTemplateHeadNode` \| `StringTemplateMiddleNode` \| `StringTemplateTailNode` \| `ExternKeywordNode` \| `DocNode` \| `DocTextNode` \| `DocReturnsTagNode` \| `DocErrorsTagNode` \| `DocParamTagNode` \| `DocTemplateTagNode` \| `DocUnknownTagNode` \| `ProjectionExpressionStatementNode` \| `ProjectionLogicalExpressionNode` \| `ProjectionRelationalExpressionNode` \| `ProjectionEqualityExpressionNode` \| `ProjectionUnaryExpressionNode` \| `ProjectionArithmeticExpressionNode` \| `ProjectionCallExpressionNode` \| `ProjectionMemberExpressionNode` \| `ProjectionDecoratorReferenceExpressionNode` \| `ProjectionTupleExpressionNode` \| `ProjectionModelExpressionNode` \| `ProjectionIfExpressionNode` \| `ProjectionBlockExpressionNode` \| `ProjectionLambdaExpressionNode` \| `IdentifierNode` \| `ReturnExpressionNode` \| `ProjectionModelSelectorNode` \| `ProjectionModelPropertySelectorNode` \| `ProjectionInterfaceSelectorNode` \| `ProjectionOperationSelectorNode` \| `ProjectionEnumSelectorNode` \| `ProjectionEnumMemberSelectorNode` \| `ProjectionUnionSelectorNode` \| `ProjectionUnionVariantSelectorNode` \| `ProjectionModelPropertyNode` \| `ProjectionModelSpreadPropertyNode` \| `ProjectionNode` | - | -| `type.projectionBase`? | `Type` | - | -| `type.projectionSource`? | `Type` | - | -| `type.projector`? | `Projector` | - | -| `type.projections` | - | -| `type.projectionsByName` | - | +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `type` | `Type` & `Object` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isApiVersion.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isApiVersion.md index 2301d84024..a94612de48 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isApiVersion.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isApiVersion.md @@ -13,7 +13,7 @@ Return whether a parameter is the Api Version parameter of a client | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | - | +| `context` | `TCGCContext` | - | | `parameter` | `ModelProperty` \| `HttpOperationParameter` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isErrorOrChildOfError.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isErrorOrChildOfError.md new file mode 100644 index 0000000000..4ce5ec840d --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isErrorOrChildOfError.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isErrorOrChildOfError" + +--- +```ts +isErrorOrChildOfError(context, model): boolean +``` + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `context` | `TCGCContext` | +| `model` | `Model` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isExclude.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isExclude.md index d035e5abec..e2072d14cb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isExclude.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isExclude.md @@ -11,7 +11,7 @@ isExclude(context, entity): boolean | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md index 736a2591b4..7230d5aa03 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInOperationGroup.md @@ -13,7 +13,7 @@ Check an operation is in an operation group. | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | | `type` | `Interface` \| `Namespace` \| `Operation` | Type to check | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInclude.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInclude.md index cba8d210e1..11febdcc9f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInclude.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInclude.md @@ -11,7 +11,7 @@ isInclude(context, entity): boolean | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInternal.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInternal.md index f1410e6902..e483822e70 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInternal.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isInternal.md @@ -14,7 +14,7 @@ should not expose them to users | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | | `entity` | `Model` \| `Enum` \| `Operation` \| `Union` | model / operation that we want to check is internal or not | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isOperationGroup.md index b6b6fcfdc5..be76c266d1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/isOperationGroup.md @@ -13,7 +13,7 @@ Check a namespace or interface is an operation group. | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | | `type` | `Interface` \| `Namespace` | Type to check | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md index 76d2c877be..9284d67196 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listClients.md @@ -13,7 +13,7 @@ List all the clients. | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md index dbd2d588fb..bccc020403 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationGroups.md @@ -16,7 +16,7 @@ List all the operation groups inside a client or an operation group. If ignoreHi | Parameter | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | `undefined` | SdkContext | +| `context` | `TCGCContext` | `undefined` | TCGCContext | | `group` | [`SdkClient`](../interfaces/SdkClient.md) \| [`SdkOperationGroup`](../interfaces/SdkOperationGroup.md) | `undefined` | Client or operation group to list operation groups | | `ignoreHierarchy` | `boolean` | `false` | Whether to get all nested operation groups | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md index 15d5ac6b22..392a37feea 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/listOperationsInOperationGroup.md @@ -16,7 +16,7 @@ List operations inside a client or an operation group. If ignoreHierarchy is tru | Parameter | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | `undefined` | - | +| `context` | `TCGCContext` | `undefined` | - | | `group` | [`SdkClient`](../interfaces/SdkClient.md) \| [`SdkOperationGroup`](../interfaces/SdkOperationGroup.md) | `undefined` | Client or operation group to list operations | | `ignoreHierarchy` | `boolean` | `false` | Whether to get all nested operations | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md index ccd9ee7e9f..07c78f5cf7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportDiagnostic.md @@ -9,7 +9,7 @@ reportDiagnostic(program, diag): void ## Type parameters -| Parameter | +| Type parameter | | :------ | | `C` extends \| `"client-name"` @@ -26,7 +26,9 @@ reportDiagnostic(program, diag): void \| `"discriminator-not-constant"` \| `"discriminator-not-string"` \| `"wrong-client-decorator"` - \| `"encoding-multipart-bytes"` | + \| `"encoding-multipart-bytes"` + \| `"unsupported-kind"` + \| `"multiple-services"` | | `M` extends `string` \| `number` \| `symbol` | ## Parameters diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportUnionUnsupported.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportUnionUnsupported.md index 7e5d753ec6..f45ed44ec9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportUnionUnsupported.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/reportUnionUnsupported.md @@ -11,7 +11,7 @@ reportUnionUnsupported(context, type): void | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `type` | `Union` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md index 0de64766ab..a783d5357f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldFlattenProperty.md @@ -13,7 +13,7 @@ Whether a model property should be flattened or not. | Parameter | Type | Description | | :------ | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | SdkContext | +| `context` | `TCGCContext` | TCGCContext | | `target` | `ModelProperty` | ModelProperty that we want to check whether it should be flattened or not | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateConvenient.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateConvenient.md index 6b7085d945..2de9f42ee8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateConvenient.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateConvenient.md @@ -11,7 +11,7 @@ shouldGenerateConvenient(context, entity): boolean | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateProtocol.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateProtocol.md index 00794dd122..d777974683 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateProtocol.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/functions/shouldGenerateProtocol.md @@ -11,7 +11,7 @@ shouldGenerateProtocol(context, entity): boolean | Parameter | Type | | :------ | :------ | -| `context` | [`SdkContext`](../interfaces/SdkContext.md)<`Record`<`string`, `any`\>\> | +| `context` | `TCGCContext` | | `entity` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md index 1029f9908b..0761a620c3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/index.md @@ -11,7 +11,6 @@ title: "[P] JS API" - [SdkClient](interfaces/SdkClient.md) - [SdkConstantType](interfaces/SdkConstantType.md) - [SdkContext](interfaces/SdkContext.md) -- [SdkDatetimeType](interfaces/SdkDatetimeType.md) - [SdkDictionaryType](interfaces/SdkDictionaryType.md) - [SdkDurationType](interfaces/SdkDurationType.md) - [SdkEmitterOptions](interfaces/SdkEmitterOptions.md) @@ -29,6 +28,7 @@ title: "[P] JS API" - [ClientFormat](type-aliases/ClientFormat.md) - [LanguageScopes](type-aliases/LanguageScopes.md) - [SdkBuiltInKinds](type-aliases/SdkBuiltInKinds.md) +- [SdkDatetimeType](type-aliases/SdkDatetimeType.md) - [SdkModelPropertyType](type-aliases/SdkModelPropertyType.md) - [SdkOperation](type-aliases/SdkOperation.md) - [SdkParameterImplementation](type-aliases/SdkParameterImplementation.md) @@ -62,12 +62,15 @@ title: "[P] JS API" - [getAccess](functions/getAccess.md) - [getAccessOverride](functions/getAccessOverride.md) - [getAllModels](functions/getAllModels.md) +- [getAllModelsWithDiagnostics](functions/getAllModelsWithDiagnostics.md) - [getClient](functions/getClient.md) - [getClientFormat](functions/getClientFormat.md) - [getClientNameOverride](functions/getClientNameOverride.md) - [getClientNamespaceString](functions/getClientNamespaceString.md) - [getClientType](functions/getClientType.md) +- [getClientTypeWithDiagnostics](functions/getClientTypeWithDiagnostics.md) - [getCrossLanguageDefinitionId](functions/getCrossLanguageDefinitionId.md) +- [getCrossLanguagePackageId](functions/getCrossLanguagePackageId.md) - [getDefaultApiVersion](functions/getDefaultApiVersion.md) - [getDocHelper](functions/getDocHelper.md) - [getEffectivePayloadType](functions/getEffectivePayloadType.md) @@ -77,22 +80,26 @@ title: "[P] JS API" - [getOperationGroup](functions/getOperationGroup.md) - [getPropertyNames](functions/getPropertyNames.md) - [getSdkArrayOrDict](functions/getSdkArrayOrDict.md) +- [getSdkArrayOrDictWithDiagnostics](functions/getSdkArrayOrDictWithDiagnostics.md) - [getSdkBuiltInType](functions/getSdkBuiltInType.md) - [getSdkConstant](functions/getSdkConstant.md) -- [getSdkDatetimeType](functions/getSdkDatetimeType.md) - [getSdkDurationType](functions/getSdkDurationType.md) - [getSdkEnum](functions/getSdkEnum.md) - [getSdkEnumValue](functions/getSdkEnumValue.md) - [getSdkModel](functions/getSdkModel.md) +- [getSdkModelWithDiagnostics](functions/getSdkModelWithDiagnostics.md) - [getSdkTuple](functions/getSdkTuple.md) +- [getSdkTupleWithDiagnostics](functions/getSdkTupleWithDiagnostics.md) - [getSdkTypeBaseHelper](functions/getSdkTypeBaseHelper.md) - [getSdkUnion](functions/getSdkUnion.md) +- [getSdkUnionWithDiagnostics](functions/getSdkUnionWithDiagnostics.md) - [getUsage](functions/getUsage.md) - [getUsageOverride](functions/getUsageOverride.md) - [getWireName](functions/getWireName.md) - [intOrFloat](functions/intOrFloat.md) - [isApiVersion](functions/isApiVersion.md) - [isAzureCoreModel](functions/isAzureCoreModel.md) +- [isErrorOrChildOfError](functions/isErrorOrChildOfError.md) - [isExclude](functions/isExclude.md) - [isInOperationGroup](functions/isInOperationGroup.md) - [isInclude](functions/isInclude.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md index c12aefb54d..41c8f84535 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkArrayType.md @@ -9,10 +9,10 @@ title: "[I] SdkArrayType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | -| `kind` | `"array"` | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | +| `kind` | `"array"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md index a5e6a6fdd7..585028422d 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBodyModelPropertyType.md @@ -9,17 +9,18 @@ title: "[I] SdkBodyModelPropertyType" ## Properties -| Property | Type | Description | Inheritance | -| :------ | :------ | :------ | :------ | -| `__raw?` | `ModelProperty` | - | [`SdkModelPropertyTypeBase.__raw`](SdkModelPropertyTypeBase.md) | -| `apiVersions` | `string`[] | - | [`SdkModelPropertyTypeBase.apiVersions`](SdkModelPropertyTypeBase.md) | -| `description?` | `string` | - | [`SdkModelPropertyTypeBase.description`](SdkModelPropertyTypeBase.md) | -| `details?` | `string` | - | [`SdkModelPropertyTypeBase.details`](SdkModelPropertyTypeBase.md) | -| `discriminator` | `boolean` | - | - | -| `isMultipartFileInput` | `boolean` | - | - | -| `kind` | `"property"` | - | - | -| `nameInClient` | `string` | - | [`SdkModelPropertyTypeBase.nameInClient`](SdkModelPropertyTypeBase.md) | -| `optional` | `boolean` | - | [`SdkModelPropertyTypeBase.optional`](SdkModelPropertyTypeBase.md) | -| `serializedName` | `string` | - | - | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | [`SdkModelPropertyTypeBase.type`](SdkModelPropertyTypeBase.md) | -| `visibility?` | `Visibility`[] | - | - | +| Property | Type | Inherited from | +| :------ | :------ | :------ | +| `__raw?` | `ModelProperty` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`__raw` | +| `apiVersions` | `string`[] | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`apiVersions` | +| `description?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`description` | +| `details?` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`details` | +| `discriminator` | `boolean` | - | +| `flatten` | `boolean` | - | +| `isMultipartFileInput` | `boolean` | - | +| `kind` | `"property"` | - | +| `nameInClient` | `string` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`nameInClient` | +| `optional` | `boolean` | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`optional` | +| `serializedName` | `string` | - | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | [`SdkModelPropertyTypeBase`](SdkModelPropertyTypeBase.md).`type` | +| `visibility?` | `Visibility`[] | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md index fae14cfb2d..79a170ea14 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkBuiltInType.md @@ -9,10 +9,10 @@ title: "[I] SdkBuiltInType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `encode` | `string` | - | - | -| `kind` | [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md) | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `kind` | [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md) | `SdkTypeBase.kind` | `SdkTypeBase.kind` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClient.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClient.md index da656c73c3..3beb9c5adb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClient.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkClient.md @@ -5,11 +5,11 @@ title: "[I] SdkClient" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `arm` | `boolean` | - | -| `crossLanguageDefinitionId` | `string` | - | -| `kind` | `"SdkClient"` | - | -| `name` | `string` | - | -| `service` | `Namespace` | - | -| `type` | `Interface` \| `Namespace` | - | +| Property | Type | +| :------ | :------ | +| `arm` | `boolean` | +| `crossLanguageDefinitionId` | `string` | +| `kind` | `"SdkClient"` | +| `name` | `string` | +| `service` | `Namespace` | +| `type` | `Interface` \| `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md index be7d96be7c..ee1a408e3c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkConstantType.md @@ -9,11 +9,11 @@ title: "[I] SdkConstantType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | -| `kind` | `"constant"` | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | +| `kind` | `"constant"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `value` | `null` \| `string` \| `number` \| `boolean` | - | - | | `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md index 512c81f6b4..0f215ef8f4 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkContext.md @@ -3,24 +3,29 @@ jsApi: true title: "[I] SdkContext" --- +## Extends + +- `TCGCContext` + ## Type parameters -| Parameter | Value | +| Type parameter | Value | | :------ | :------ | | `TOptions` extends `object` | `Record`<`string`, `any`\> | ## Properties -| Property | Type | Description | +| Property | Type | Inherited from | | :------ | :------ | :------ | -| `arm?` | `boolean` | - | +| `arm?` | `boolean` | `TCGCContext.arm` | | `emitContext` | `EmitContext`<`TOptions`\> | - | -| `emitterName` | `string` | - | -| `filterOutCoreModels?` | `boolean` | - | -| `generateConvenienceMethods` | `boolean` | - | -| `generateProtocolMethods` | `boolean` | - | -| `generatedNames?` | `Set`<`string`\> | - | -| `modelsMap?` | `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\> | - | -| `operationModelsMap?` | `Map`<`Operation`, `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\>\> | - | -| `packageName?` | `string` | - | -| `program` | `Program` | - | +| `emitterName` | `string` | `TCGCContext.emitterName` | +| `filterOutCoreModels?` | `boolean` | `TCGCContext.filterOutCoreModels` | +| `generateConvenienceMethods?` | `boolean` | `TCGCContext.generateConvenienceMethods` | +| `generateProtocolMethods?` | `boolean` | `TCGCContext.generateProtocolMethods` | +| `generatedNames?` | `Set`<`string`\> | `TCGCContext.generatedNames` | +| `knownScalars?` | `Record`<`string`, [`SdkBuiltInKinds`](../type-aliases/SdkBuiltInKinds.md)\> | `TCGCContext.knownScalars` | +| `modelsMap?` | `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\> | `TCGCContext.modelsMap` | +| `operationModelsMap?` | `Map`<`Operation`, `Map`<`Type`, [`SdkModelType`](SdkModelType.md) \| [`SdkEnumType`](SdkEnumType.md)\>\> | `TCGCContext.operationModelsMap` | +| `packageName?` | `string` | `TCGCContext.packageName` | +| `program` | `Program` | `TCGCContext.program` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md deleted file mode 100644 index c4ceba012d..0000000000 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDatetimeType.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -jsApi: true -title: "[I] SdkDatetimeType" - ---- -## Extends - -- `SdkTypeBase` - -## Properties - -| Property | Type | Description | Inheritance | -| :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | -| `encode` | `DateTimeKnownEncoding` | - | - | -| `kind` | `"datetime"` | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | -| `wireType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md index 33b834fb0d..c2cbc2f268 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDictionaryType.md @@ -9,11 +9,11 @@ title: "[I] SdkDictionaryType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `keyType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | -| `kind` | `"dict"` | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `kind` | `"dict"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md index 5db2371dda..77555990df 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkDurationType.md @@ -9,11 +9,11 @@ title: "[I] SdkDurationType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `encode` | `DurationKnownEncoding` | - | - | -| `kind` | `"duration"` | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `kind` | `"duration"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `wireType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md index 52f4e95580..6e5f497410 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEmitterOptions.md @@ -5,9 +5,9 @@ title: "[I] SdkEmitterOptions" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `filter-out-core-models?` | `boolean` | - | -| `generate-convenience-methods?` | `boolean` | - | -| `generate-protocol-methods?` | `boolean` | - | -| `package-name?` | `string` | - | +| Property | Type | +| :------ | :------ | +| `filter-out-core-models?` | `boolean` | +| `generate-convenience-methods?` | `boolean` | +| `generate-protocol-methods?` | `boolean` | +| `package-name?` | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md index 7e0d7faaba..c9276873f1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumType.md @@ -9,19 +9,20 @@ title: "[I] SdkEnumType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | | `access` | `undefined` \| [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | | `crossLanguageDefinitionId` | `string` | - | - | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `description?` | `string` | - | - | | `details?` | `string` | - | - | +| `generatedName?` | `string` | - | - | | `isFixed` | `boolean` | - | - | | `isFlags` | `boolean` | - | - | -| `kind` | `"enum"` | - | `SdkTypeBase.kind` | +| `kind` | `"enum"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | | `name` | `string` | - | - | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `usage` | `UsageFlags` | - | - | | `valueType` | [`SdkBuiltInType`](SdkBuiltInType.md) | - | - | | `values` | [`SdkEnumValueType`](SdkEnumValueType.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md index 9260c09bc1..45a9e61f5c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkEnumValueType.md @@ -9,15 +9,15 @@ title: "[I] SdkEnumValueType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `description?` | `string` | - | - | | `details?` | `string` | - | - | | `enumType` | [`SdkEnumType`](SdkEnumType.md) | - | - | -| `kind` | `"enumvalue"` | - | `SdkTypeBase.kind` | +| `kind` | `"enumvalue"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | | `name` | `string` | - | - | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `value` | `string` \| `number` | - | - | | `valueType` | [`SdkType`](../type-aliases/SdkType.md) | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md index 557becf6e3..37853db37e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelPropertyTypeBase.md @@ -3,18 +3,18 @@ jsApi: true title: "[I] SdkModelPropertyTypeBase" --- -## Extended By +## Extended by - [`SdkBodyModelPropertyType`](SdkBodyModelPropertyType.md) ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `__raw?` | `ModelProperty` | - | -| `apiVersions` | `string`[] | - | -| `description?` | `string` | - | -| `details?` | `string` | - | -| `nameInClient` | `string` | - | -| `optional` | `boolean` | - | -| `type` | [`SdkType`](../type-aliases/SdkType.md) | - | +| Property | Type | +| :------ | :------ | +| `__raw?` | `ModelProperty` | +| `apiVersions` | `string`[] | +| `description?` | `string` | +| `details?` | `string` | +| `nameInClient` | `string` | +| `optional` | `boolean` | +| `type` | [`SdkType`](../type-aliases/SdkType.md) | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md index 1f98469301..075235354f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkModelType.md @@ -9,22 +9,23 @@ title: "[I] SdkModelType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | | `access` | `undefined` \| [`AccessFlags`](../type-aliases/AccessFlags.md) | - | - | | `additionalProperties` | `undefined` \| [`SdkType`](../type-aliases/SdkType.md) | - | - | | `baseModel?` | [`SdkModelType`](SdkModelType.md) | - | - | | `crossLanguageDefinitionId` | `string` | - | - | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `description?` | `string` | - | - | | `details?` | `string` | - | - | | `discriminatedSubtypes?` | `Record`<`string`, [`SdkModelType`](SdkModelType.md)\> | - | - | | `discriminatorValue?` | `string` | - | - | | `generatedName?` | `string` | - | - | +| `isError` | `boolean` | - | - | | `isFormDataType` | `boolean` | - | - | -| `kind` | `"model"` | - | `SdkTypeBase.kind` | +| `kind` | `"model"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | | `name` | `string` | - | - | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `properties` | [`SdkModelPropertyType`](../type-aliases/SdkModelPropertyType.md)[] | - | - | | `usage` | `UsageFlags` | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md index f07c95ec2c..4766549815 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkOperationGroup.md @@ -5,9 +5,9 @@ title: "[I] SdkOperationGroup" --- ## Properties -| Property | Type | Description | -| :------ | :------ | :------ | -| `groupPath` | `string` | - | -| `kind` | `"SdkOperationGroup"` | - | -| `subOperationGroups?` | [`SdkOperationGroup`](SdkOperationGroup.md)[] | - | -| `type` | `Interface` \| `Namespace` | - | +| Property | Type | +| :------ | :------ | +| `groupPath` | `string` | +| `kind` | `"SdkOperationGroup"` | +| `subOperationGroups?` | [`SdkOperationGroup`](SdkOperationGroup.md)[] | +| `type` | `Interface` \| `Namespace` | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md index 2530b58fb6..bd067f9718 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkTupleType.md @@ -9,10 +9,10 @@ title: "[I] SdkTupleType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | -| `kind` | `"tuple"` | - | `SdkTypeBase.kind` | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | +| `kind` | `"tuple"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `values` | [`SdkType`](../type-aliases/SdkType.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md index 9925905134..bc120e45e0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/interfaces/SdkUnionType.md @@ -9,12 +9,12 @@ title: "[I] SdkUnionType" ## Properties -| Property | Type | Description | Inheritance | +| Property | Type | Overrides | Inherited from | | :------ | :------ | :------ | :------ | -| `__raw?` | `Type` | - | `SdkTypeBase.__raw` | -| `deprecation?` | `string` | - | `SdkTypeBase.deprecation` | +| `__raw?` | `Type` | `SdkTypeBase.__raw` | `SdkTypeBase.__raw` | +| `deprecation?` | `string` | `SdkTypeBase.deprecation` | `SdkTypeBase.deprecation` | | `generatedName?` | `string` | - | - | -| `kind` | `"union"` | - | `SdkTypeBase.kind` | +| `kind` | `"union"` | `SdkTypeBase.kind` | `SdkTypeBase.kind` | | `name?` | `string` | - | - | -| `nullable` | `boolean` | - | `SdkTypeBase.nullable` | +| `nullable` | `boolean` | `SdkTypeBase.nullable` | `SdkTypeBase.nullable` | | `values` | [`SdkType`](../type-aliases/SdkType.md)[] | - | - | diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkDatetimeType.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkDatetimeType.md new file mode 100644 index 0000000000..1a0e87f747 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/type-aliases/SdkDatetimeType.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[T] SdkDatetimeType" + +--- +```ts +type SdkDatetimeType: SdkUtcDatetimeType | SdkOffsetDatetimeType; +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md index 485c4c5cfa..2c694988e0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/libraries/typespec-client-generator-core/reference/js-api/variables/$lib.md @@ -9,7 +9,7 @@ const $lib: TypeSpecLibrary, never>; ## Type declaration -| Member | Type | Description | +| Member | Type | Value | | :------ | :------ | :------ | | `access` | `Object` | - | | `access.default` | `string` | - | @@ -18,29 +18,33 @@ const $lib: TypeSpecLibrary, never>; | `client-service` | `Object` | - | | `client-service.default` | `CallableMessage`<[`string`]\> | - | | `conflicting-multipart-model-usage` | `Object` | - | -| `conflicting-multipart-model-usage.default` | `string` | - | +| `conflicting-multipart-model-usage.default` | `string` | "Invalid encoding" | | `conflicting-multipart-model-usage.wrongType` | `CallableMessage`<[`string`, `string`, `string`]\> | - | | `discriminator-not-constant` | `Object` | - | | `discriminator-not-constant.default` | `CallableMessage`<[`string`]\> | - | | `discriminator-not-string` | `Object` | - | | `discriminator-not-string.default` | `CallableMessage`<[`string`, `string`]\> | - | | `encoding-multipart-bytes` | `Object` | - | -| `encoding-multipart-bytes.default` | `string` | - | +| `encoding-multipart-bytes.default` | `string` | "Encoding should not be applied to bytes content in a multipart request. This is semi-incompatible with how multipart works in HTTP." | | `incorrect-client-format` | `Object` | - | | `incorrect-client-format.default` | `CallableMessage`<[`string`, `string`]\> | - | | `invalid-encode` | `Object` | - | -| `invalid-encode.default` | `string` | - | +| `invalid-encode.default` | `string` | "Invalid encoding" | | `invalid-encode.wrongType` | `CallableMessage`<[`string`, `string`]\> | - | | `invalid-usage` | `Object` | - | | `invalid-usage.default` | `string` | - | +| `multiple-services` | `Object` | - | +| `multiple-services.default` | `CallableMessage`<[`string`]\> | - | | `union-null` | `Object` | - | -| `union-null.default` | `string` | - | +| `union-null.default` | `string` | "Cannot have a union containing only null types." | | `union-unsupported` | `Object` | - | -| `union-unsupported.default` | `string` | - | -| `union-unsupported.null` | `string` | - | +| `union-unsupported.default` | `string` | "Unions cannot be emitted by our language generators unless all options are literals of the same type." | +| `union-unsupported.null` | `string` | "Unions containing multiple model types cannot be emitted unless the union is between one model type and 'null'." | | `unknown-client-format` | `Object` | - | | `unknown-client-format.default` | `CallableMessage`<[`string`, `string`]\> | - | +| `unsupported-kind` | `Object` | - | +| `unsupported-kind.default` | `CallableMessage`<[`string`]\> | - | | `use-enum-instead` | `Object` | - | -| `use-enum-instead.default` | `string` | - | +| `use-enum-instead.default` | `string` | "Use enum instead of union of string or number literals. Falling back to the literal type." | | `wrong-client-decorator` | `Object` | - | -| `wrong-client-decorator.default` | `string` | - | +| `wrong-client-decorator.default` | `string` | "@client or @operationGroup should decorate namespace or interface in client.tsp" | diff --git a/packages/website/versioned_docs/version-latest/reference/azure-style-guide.md b/packages/website/versioned_docs/version-latest/reference/azure-style-guide.md index 81bfd1602f..84c92d49f4 100644 --- a/packages/website/versioned_docs/version-latest/reference/azure-style-guide.md +++ b/packages/website/versioned_docs/version-latest/reference/azure-style-guide.md @@ -50,7 +50,7 @@ in Azure TypeSpec definitions. Instead, we recommend using supported scalars. Azure-specific scalars include: `eTag`, `ipV4Address`, `ipV6Address` and `uuid`. General TypeSpec scalars include: `bytes`, `numeric`, `integer`, `float`, `int64`, `int32`, `int16`, `int8`, `uint64`, `uint32`, `uint16`, `uint8`, `safeint`, `float64`, `float32`, `decimal`, `decimal128`, `string`, `plainDate`, `plainTime`, `utcDateTime`, `offsetDateTime`, `duration`, - `boolean`, and `url`. For more information, see the document on [Types Relations](https://microsoft.github.io/typespec/language-basics/type-relations) + `boolean`, and `url`. For more information, see the document on [Types Relations](https://typespec.io/docs/language-basics/type-relations) ## Operation Groups diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md b/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md index c2ed13e954..7183580517 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2022-10-12.md @@ -6,7 +6,7 @@ title: October 2022 This release contains **breaking changes** -Change to compiler, rest libraries [See TypeSpec Core release notes](https://microsoft.github.io/typespec/docs/release-notes/release-2022-10-12/) +Change to compiler, rest libraries [See TypeSpec Core release notes](https://typespec.io/docs/release-notes/release-2022-10-12/) - **`TypeSpec`**: Cannot `extends` or `is` a model expression via alias - **`Api`**: Removed `createProgram` and changed `compile` parameter order diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md b/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md index d8052e3756..df6eeb15f2 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2022-12-07.md @@ -8,11 +8,11 @@ title: December 2022 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2022-12-07) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2022-12-07) ## Breaking change -See TypeSpec Core breaking changes in [release notes](https://microsoft.github.io/typespec/release-notes/release-2022-12-07) +See TypeSpec Core breaking changes in [release notes](https://typespec.io/docs/release-notes/release-2022-12-07) ### `TypeSpec > @azure-tools/typespec-azure-core` - change in handling of extensible enums diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-01-12.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-01-12.md index 3d8c9260a6..faafb446d7 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-01-12.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-01-12.md @@ -8,7 +8,7 @@ title: January 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-01-12) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-01-12) ## Breaking Changes diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md index 703ac950be..9ef0175c6d 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-02-07.md @@ -8,7 +8,7 @@ title: February 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-02-07) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-02-07) ## New Features diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md index 5f55ec9a75..bba220ebec 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-03-13.md @@ -8,7 +8,7 @@ title: March 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-03-13) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-03-13) See [Cadl to TypeSpec rename and migration FAQ](./cadl-typespec-migration.md) diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md index 1bd3bbc619..3d89633778 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-04-11.md @@ -8,7 +8,7 @@ title: April 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-04-11) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-04-11) ## New Features diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md index 53b9ddd2a7..9955124337 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-05-10.md @@ -4,7 +4,7 @@ title: May 2023 # Release Notes May 2023 (2023-05-10) -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-05-10) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-05-10) ## New Features diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-06-06.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-06-06.md index 07b39b2520..e3ce815cd4 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-06-06.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-06-06.md @@ -8,7 +8,7 @@ title: June 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-06-06) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-06-06) ## New Features diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md index dd4ed1d05a..987248a122 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-07-11.md @@ -8,7 +8,7 @@ title: July 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-07-11) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-07-11) ## New Features @@ -59,4 +59,4 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -There are breaking changes in typespec core libraries, see [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-07-11) for details. +There are breaking changes in typespec core libraries, see [release notes](https://typespec.io/docs/release-notes/release-2023-07-11) for details. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md index a21e5fc415..1da7752f40 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-08-08.md @@ -8,7 +8,7 @@ title: August 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-08-08) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-08-08) ## New Features @@ -52,4 +52,4 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -- There are breaking changes in the TypeSpec core compiler, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2023-08-08) for details. +- There are breaking changes in the TypeSpec core compiler, see [the release notes](https://typespec.io/docs/release-notes/release-2023-08-08) for details. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md index b84effce63..fae3577af4 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-09-12.md @@ -8,7 +8,7 @@ title: September 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-09-12) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-09-12) ## New Features @@ -96,7 +96,7 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -- There are breaking changes in the TypeSpec core compiler, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2023-09-12) for details. +- There are breaking changes in the TypeSpec core compiler, see [the release notes](https://typespec.io/docs/release-notes/release-2023-09-12) for details. ### `@azure-tools/typespec-azure-core` Breaking Changes diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md index 603baf4e1c..35e626cdb3 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-10-11.md @@ -8,7 +8,7 @@ title: October 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-10-11) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-10-11) ## New Features @@ -51,7 +51,7 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2023-10-11) for details. +- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://typespec.io/docs/release-notes/release-2023-10-11) for details. ### `@azure-tools/typespec-azure-core` Breaking Changes diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md index 787e9cf02c..d10f5a4f67 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-11-07.md @@ -8,7 +8,7 @@ title: November 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-11-07) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-11-07) ## New Features @@ -69,7 +69,7 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2023-11-07) for details. +- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://typespec.io/docs/release-notes/release-2023-11-07) for details. ### Typescript types breaking change diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2023-12-06.md b/packages/website/versioned_docs/version-latest/release-notes/release-2023-12-06.md index 7cd5622e46..6eae016b88 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2023-12-06.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2023-12-06.md @@ -8,7 +8,7 @@ title: December 2023 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2023-12-06) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2023-12-06) ## New Features @@ -65,4 +65,4 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2023-12-06) for details. +- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://typespec.io/docs/release-notes/release-2023-12-06) for details. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md index 603f45b895..2e23734cb1 100644 --- a/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-01-23.md @@ -8,7 +8,7 @@ title: January 2024 This release contains **breaking changes** ::: -See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-notes/release-2024-01-23) +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2024-01-23) ## New Features @@ -56,4 +56,4 @@ See TypeSpec Core [release notes](https://microsoft.github.io/typespec/release-n ## Breaking Changes -- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://microsoft.github.io/typespec/release-notes/release-2024-01-23) for details. +- There are breaking changes in the TypeSpec core libraries, see [the release notes](https://typespec.io/docs/release-notes/release-2024-01-23) for details. diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-03-05.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-03-05.md new file mode 100644 index 0000000000..a7b7625812 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-03-05.md @@ -0,0 +1,72 @@ +--- +title: March 2024 +--- + +# Release Notes March 2024 (2024-03-05) + +See TypeSpec Core [release notes](https://typespec.io/docs/release-notes/release-2024-03-05) + +:::warn +This release contains breaking changes in typespec core. +::: + +## Breaking changes + +### `@azure-tools/typespec-client-generator-core` + +- [#295](https://github.com/Azure/typespec-azure/pull/295) [API] Split datetime type into utcDateTime and offsetDateTime to remain in sync with tsp + +## Features + +### `@azure-tools/typespec-autorest` + +- [#337](https://github.com/Azure/typespec-azure/pull/337) Add support for all properties of openapi `info` object on the `@info` decorator +- [#277](https://github.com/Azure/typespec-azure/pull/277) Support `@flattenProperty` decorator. + +### `@azure-tools/typespec-azure-core` + +- [#341](https://github.com/Azure/typespec-azure/pull/341) Add new `azureLocation` scalar +- [#258](https://github.com/Azure/typespec-azure/pull/258) Implement code fixes for `no-enum` linter rule + +### `@azure-tools/typespec-azure-resource-manager` + +- [#304](https://github.com/Azure/typespec-azure/pull/304) Add `arm-no-record` rule. +- [#283](https://github.com/Azure/typespec-azure/pull/283) Added `ArmResourceHead` operation template +- [#298](https://github.com/Azure/typespec-azure/pull/298) ARM: add `arm-delete-response-codes` rule. +- [#317](https://github.com/Azure/typespec-azure/pull/317) Add ruleset `canonical-versioning` to Azure Resource Manager library. + +### `@azure-tools/typespec-client-generator-core` + +- [#341](https://github.com/Azure/typespec-azure/pull/341) add support for azureLocation scalar in azure core +- [#242](https://github.com/Azure/typespec-azure/pull/242) add flattened property onto SdkBodyModelPropertyType +- [#315](https://github.com/Azure/typespec-azure/pull/315) add validation on import of tcgc and remove duplicate validation warnings +- [#350](https://github.com/Azure/typespec-azure/pull/350) add helper function getCrossLanguagePackageId. getCrossLanguagePackageId returns a package id that is consistent across languages, allowing emitters to identify that they are generating from the same service tsp +- [#306](https://github.com/Azure/typespec-azure/pull/306) add getClientTypeWithDiagnostics and getAllModelsWithDiagnostics to get values back with diagnostics + +### `@azure-tools/typespec-azure-portal-core` + +- [#287](https://github.com/Azure/typespec-azure/pull/287) adding new decorator called `@promotion` and adding validation rule for `@about.LearnMoreDocs` + +## Bug Fixes + +### `@azure-tools/typespec-azure-core` + +- [#231](https://github.com/Azure/typespec-azure/pull/231) Azure `Page` type `nextLink` properties are now marked as `readonly` + +### `@azure-tools/typespec-azure-resource-manager` + +- [#323](https://github.com/Azure/typespec-azure/pull/323) Adding `@visibility("read")` & optional linting rules linting rules for ARM `provisioningState` +- [#366](https://github.com/Azure/typespec-azure/pull/366) Fix for issue #254 cannot customize response in ARM PUT templates + +### `@azure-tools/typespec-client-generator-core` + +- [#305](https://github.com/Azure/typespec-azure/pull/305) getAllModels will return models only used as final envelope results in non-ARM definitions +- [#335](https://github.com/Azure/typespec-azure/pull/335) unions with only null and another type will not be converted to union +- [#362](https://github.com/Azure/typespec-azure/pull/362) enhance logic for value type of enum and union as enum +- [#314](https://github.com/Azure/typespec-azure/pull/314) support @clientName for extensible enum variant +- [#328](https://github.com/Azure/typespec-azure/pull/328) add support for anonymous union as enum and fix union as enum variant discriminator typing problem +- [#301](https://github.com/Azure/typespec-azure/pull/301) Add usage calculation for additional properties with model type +- [#327](https://github.com/Azure/typespec-azure/pull/327) rollback some of the breaking changes for common model types method +- [#260](https://github.com/Azure/typespec-azure/pull/260) allow models to have a union variant as a discriminator +- [#286](https://github.com/Azure/typespec-azure/pull/286) don't throw for unknown format +- [#274](https://github.com/Azure/typespec-azure/pull/274) Update doc for `@access` and `@usage` diff --git a/packages/website/versioned_docs/version-latest/typespec-getting-started.md b/packages/website/versioned_docs/version-latest/typespec-getting-started.md index e8b9201249..8387d6a010 100644 --- a/packages/website/versioned_docs/version-latest/typespec-getting-started.md +++ b/packages/website/versioned_docs/version-latest/typespec-getting-started.md @@ -10,7 +10,7 @@ TypeSpec can emit the following artifacts for your service: - OpenAPI3 specs - OpenAPI2 specs, suitable for check-in in to the azure-rest-api-specs repo -For more information on the TypeSpec language and core libraries, see [Getting started with TypeSpec](https://microsoft.github.io/typespec) +For more information on the TypeSpec language and core libraries, see [Getting started with TypeSpec](https://typespec.io/docs) ## Setting up TypeSpec and compile first project @@ -28,7 +28,7 @@ There are two simple options for getting TypeSpec up and running in your environ - Run `tsp compile` in the project folder will compile the TypeSpec project and emit output in `tsp-output` folder. -Once TypeSpec project has been create, the [TypeSpec language tutorial](https://microsoft.github.io/typespec) provides a good overview of the basics of the language. +Once TypeSpec project has been create, the [TypeSpec language tutorial](https://typespec.io/docs) provides a good overview of the basics of the language. ## Getting Started for Azure Management Plane Services @@ -41,7 +41,7 @@ Use the resources in this section for creating Azure ARM rest API specs. For Pro - Documentation - [Getting started with TypeSpec for REST APIs](https://github.com/microsoft/typespec/blob/main/README.md#getting-started) - - [TypeSpec language tutorial](https://microsoft.github.io/typespec) + - [TypeSpec language tutorial](https://typespec.io/docs) - [TypeSpec Swagger Cheat Sheet](https://github.com/microsoft/typespec/blob/main/docs/typespec-for-openapi-dev.md) - Samples - [Petstore Sample using Low-level Http APIs](https://github.com/microsoft/typespec/tree/main/packages/samples/petstore) diff --git a/packages/website/versioned_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index a6975bb472..9e01c26ed1 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -95,6 +95,20 @@ "dirName": "libraries/typespec-client-generator-core/reference" } ] + }, + { + "type": "category", + "label": "Azure.Portal", + "link": { + "type": "doc", + "id": "libraries/azure-portal-core/reference/index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "libraries/azure-portal-core/reference" + } + ] } ] },