Preview
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in
Glossary
The Locally-specific terms the rest of the documentation uses.
- Automatic Configuration
- What
locally rundoes: sets the environment variables a tool reads (endpoints, credentials, subscription, CA bundle) so it targets Locally instead of Azure with no change to your code or configuration. More. - Built-in provider
- A Resource Provider that's part of Locally itself rather than a plugin, such as Microsoft.Resources, Microsoft.Authorization and Microsoft.Management. It's always there, so it never needs installing.
- CI Key
- A secret from your Locally Account that lets
locally cisign in when your CI system can't issue OIDC tokens. Set it asLOCALLY_CI_KEY. More. - Data Plane Emulator
- The part of Locally that speaks a service's own protocol (Blob REST, AMQP, the Cosmos SQL API) as opposed to the management API that provisions it. List.
- Default identity
- The service principal
locally runsigns in as, unless you tell it otherwise. It's an Owner of every seeded Subscription and a Global Administrator in the directory, and its client ID stays the same between launches. - Ephemeral
- By default, everything you provision in Locally is removed when it stops. Start Locally with
--persistto keep it. - Installation certificate
- A client certificate issued to this install by your Locally Account when you sign in. It carries your plan and is what Locally presents to
api.locally.build; it is renewed at least every 32 days and removed bylocally logout. Distinct from the local CA and TLS certificate, which secure the endpoints on your machine. - Locally Account
- Your sign-in at
account.locally.build: plan, installations, and for Team plans the shared runbooks, policies and directory. Optional - without one you get 60-minute sessions, the six core plugins and 3 more of your choice. - Locally region
- Locally has its own region names (
berlin, notwesteurope) so by default a configuration can't target the wrong cloud by accident. Azure's names are available on the Team plan, and every plan can see its Regions and their status on the Regions page in Settings. More. - Plugin
- One Resource Provider namespace (
Microsoft.Storage,Microsoft.KeyVault, …) packaged as its own process, installed into the config directory bylocally plugin installand launched bylocally build. What you install decides which resource types the control plane serves. Registering a Resource Provider whose plugin isn't installed installs it, if your plan includes it. - Runbook
- Team-shared infrastructure you can replay into a fresh environment: ARM/Bicep templates, database scripts and directory objects, run in order, optionally at every launch. More.
- Seeded
- Created the same way every time Locally starts: the default tenant, your plan's subscriptions, the default identity, and the example directory of users, groups and service principals.
- Session
- One run of
locally build, from start to stop. How long a session can last depends on your plan. Unless you start Locally with--persist, everything you provision is removed when it ends. - Snapshot
- A copy of everything in Locally at a point in time, including your resources, the directory and the data in the Data Plane Emulators, which you can restore, compare or share with your team. Needs the Standard plan. More.
Preview
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in