Create Crate

Creating a New Crate

All new service crates must be generated from TypeSpec specifications in Azure/azure-rest-api-specs. Do not hand-write client libraries from scratch.

• Install tsp-client
• Follow eng/common/tsp-client/README.md to install dependencies
• Run npm ci from eng/common/tsp-client/
• Use npm exec --prefix eng/common/tsp-client -- tsp-client {command} to invoke it from the repository root

• Find the TypeSpec spec
• Look for a tspconfig.yaml under specification/{service}/ in azure-rest-api-specs
• Check the tspconfig.yaml for @azure-tools/typespec-rust emitter configuration
• If no emitter configuration exists, stop and report an error indicating that the TypeSpec specification in Azure/azure-rest-api-specs must be updated before generating the client

• Initialize the crate
• Run npm exec --prefix eng/common/tsp-client -- tsp-client init --tsp-config {url} from the repository root
• {url} is the GitHub URL to the tspconfig.yaml
• Always use a specific commit SHA in the URL — never a branch or tag, which can move
• Example: https://github.com/Azure/azure-rest-api-specs/blob/{commit-sha}/specification/{service}/{rp}/tspconfig.yaml

• Generate the client
• Use the azsdk_package_generate_code MCP tool, or
• Run npm exec --prefix eng/common/tsp-client -- tsp-client update from the crate directory

• Add hand-written wrappers
• Create clients.rs (or similar) for custom client constructors, authentication setup, and convenience methods
• Build on top of the generated code in src/generated/

• Register the crate
• Add the new crate to the workspace members list in the root Cargo.toml

• Add tests, examples, and documentation
• Write unit tests and integration tests (using #[recorded::test])
• Add examples, a README.md, and a CHANGELOG.md