@microsoft/managed-apps-cli 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +153 -0
- package/README.md +280 -0
- package/dist/ArgumentProvider.d.ts +102 -0
- package/dist/ArgumentProvider.d.ts.map +1 -0
- package/dist/ArgumentProvider.js +376 -0
- package/dist/ArgumentProvider.js.map +1 -0
- package/dist/Authentication/NodeMsalAuthenticationProvider.d.ts +18 -0
- package/dist/Authentication/NodeMsalAuthenticationProvider.d.ts.map +1 -0
- package/dist/Authentication/NodeMsalAuthenticationProvider.js +99 -0
- package/dist/Authentication/NodeMsalAuthenticationProvider.js.map +1 -0
- package/dist/Authentication/OrchardAuthenticationProvider.d.ts +13 -0
- package/dist/Authentication/OrchardAuthenticationProvider.d.ts.map +1 -0
- package/dist/Authentication/OrchardAuthenticationProvider.js +30 -0
- package/dist/Authentication/OrchardAuthenticationProvider.js.map +1 -0
- package/dist/Authentication/ServicePrincipalAuthenticationProvider.d.ts +23 -0
- package/dist/Authentication/ServicePrincipalAuthenticationProvider.d.ts.map +1 -0
- package/dist/Authentication/ServicePrincipalAuthenticationProvider.js +60 -0
- package/dist/Authentication/ServicePrincipalAuthenticationProvider.js.map +1 -0
- package/dist/Bin.d.ts +6 -0
- package/dist/Bin.d.ts.map +1 -0
- package/dist/Bin.js +7 -0
- package/dist/Bin.js.map +1 -0
- package/dist/Cli.d.ts +2 -0
- package/dist/Cli.d.ts.map +1 -0
- package/dist/Cli.js +91 -0
- package/dist/Cli.js.map +1 -0
- package/dist/CliSettings.d.ts +14 -0
- package/dist/CliSettings.d.ts.map +1 -0
- package/dist/CliSettings.js +78 -0
- package/dist/CliSettings.js.map +1 -0
- package/dist/CliUtils.d.ts +92 -0
- package/dist/CliUtils.d.ts.map +1 -0
- package/dist/CliUtils.js +218 -0
- package/dist/CliUtils.js.map +1 -0
- package/dist/Constants/CliConstants.d.ts +6 -0
- package/dist/Constants/CliConstants.d.ts.map +1 -0
- package/dist/Constants/CliConstants.js +6 -0
- package/dist/Constants/CliConstants.js.map +1 -0
- package/dist/Constants/CommandRegistry.d.ts +23 -0
- package/dist/Constants/CommandRegistry.d.ts.map +1 -0
- package/dist/Constants/CommandRegistry.js +193 -0
- package/dist/Constants/CommandRegistry.js.map +1 -0
- package/dist/Constants/HelpStrings.d.ts +321 -0
- package/dist/Constants/HelpStrings.d.ts.map +1 -0
- package/dist/Constants/HelpStrings.js +438 -0
- package/dist/Constants/HelpStrings.js.map +1 -0
- package/dist/Constants.d.ts +10 -0
- package/dist/Constants.d.ts.map +1 -0
- package/dist/Constants.js +18 -0
- package/dist/Constants.js.map +1 -0
- package/dist/Errors/CliError.d.ts +5 -0
- package/dist/Errors/CliError.d.ts.map +1 -0
- package/dist/Errors/CliError.js +7 -0
- package/dist/Errors/CliError.js.map +1 -0
- package/dist/FS/CliFs.d.ts +41 -0
- package/dist/FS/CliFs.d.ts.map +1 -0
- package/dist/FS/CliFs.js +136 -0
- package/dist/FS/CliFs.js.map +1 -0
- package/dist/HttpClient/CliHttpClient.d.ts +24 -0
- package/dist/HttpClient/CliHttpClient.d.ts.map +1 -0
- package/dist/HttpClient/CliHttpClient.js +122 -0
- package/dist/HttpClient/CliHttpClient.js.map +1 -0
- package/dist/HttpClient/OrchardProxy.d.ts +11 -0
- package/dist/HttpClient/OrchardProxy.d.ts.map +1 -0
- package/dist/HttpClient/OrchardProxy.js +25 -0
- package/dist/HttpClient/OrchardProxy.js.map +1 -0
- package/dist/HttpClient/Proxy.d.ts +7 -0
- package/dist/HttpClient/Proxy.d.ts.map +1 -0
- package/dist/HttpClient/Proxy.js +5 -0
- package/dist/HttpClient/Proxy.js.map +1 -0
- package/dist/Logger/CliLogger.d.ts +36 -0
- package/dist/Logger/CliLogger.d.ts.map +1 -0
- package/dist/Logger/CliLogger.js +235 -0
- package/dist/Logger/CliLogger.js.map +1 -0
- package/dist/Logger/ConsoleWriter.d.ts +15 -0
- package/dist/Logger/ConsoleWriter.d.ts.map +1 -0
- package/dist/Logger/ConsoleWriter.js +45 -0
- package/dist/Logger/ConsoleWriter.js.map +1 -0
- package/dist/Logger/Constants.d.ts +6 -0
- package/dist/Logger/Constants.d.ts.map +1 -0
- package/dist/Logger/Constants.js +15 -0
- package/dist/Logger/Constants.js.map +1 -0
- package/dist/Logger/LoggerSettings.d.ts +19 -0
- package/dist/Logger/LoggerSettings.d.ts.map +1 -0
- package/dist/Logger/LoggerSettings.js +114 -0
- package/dist/Logger/LoggerSettings.js.map +1 -0
- package/dist/Logger/OneDSWriter.d.ts +22 -0
- package/dist/Logger/OneDSWriter.d.ts.map +1 -0
- package/dist/Logger/OneDSWriter.js +129 -0
- package/dist/Logger/OneDSWriter.js.map +1 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensions.d.ts +5 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensions.d.ts.map +1 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensions.js +46 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensions.js.map +1 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensionsConfig.d.ts +27 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensionsConfig.d.ts.map +1 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensionsConfig.js +168 -0
- package/dist/Logger/Scrubber/ScrubCustomDimensionsConfig.js.map +1 -0
- package/dist/Logger/Scrubber/ScrubUtils.d.ts +8 -0
- package/dist/Logger/Scrubber/ScrubUtils.d.ts.map +1 -0
- package/dist/Logger/Scrubber/ScrubUtils.js +34 -0
- package/dist/Logger/Scrubber/ScrubUtils.js.map +1 -0
- package/dist/Types/Argument.types.d.ts +27 -0
- package/dist/Types/Argument.types.d.ts.map +1 -0
- package/dist/Types/Argument.types.js +5 -0
- package/dist/Types/Argument.types.js.map +1 -0
- package/dist/Types/Cli.types.d.ts +32 -0
- package/dist/Types/Cli.types.d.ts.map +1 -0
- package/dist/Types/Cli.types.js +5 -0
- package/dist/Types/Cli.types.js.map +1 -0
- package/dist/Types/Command.types.d.ts +52 -0
- package/dist/Types/Command.types.d.ts.map +1 -0
- package/dist/Types/Command.types.js +8 -0
- package/dist/Types/Command.types.js.map +1 -0
- package/dist/Types/Datasource.types.d.ts +43 -0
- package/dist/Types/Datasource.types.d.ts.map +1 -0
- package/dist/Types/Datasource.types.js +5 -0
- package/dist/Types/Datasource.types.js.map +1 -0
- package/dist/Types/LoggerTypes.types.d.ts +17 -0
- package/dist/Types/LoggerTypes.types.d.ts.map +1 -0
- package/dist/Types/LoggerTypes.types.js +5 -0
- package/dist/Types/LoggerTypes.types.js.map +1 -0
- package/dist/Utils/BuildVerbDescriptionTable.d.ts +19 -0
- package/dist/Utils/BuildVerbDescriptionTable.d.ts.map +1 -0
- package/dist/Utils/BuildVerbDescriptionTable.js +87 -0
- package/dist/Utils/BuildVerbDescriptionTable.js.map +1 -0
- package/dist/Utils/ConsoleOutput.d.ts +80 -0
- package/dist/Utils/ConsoleOutput.d.ts.map +1 -0
- package/dist/Utils/ConsoleOutput.js +151 -0
- package/dist/Utils/ConsoleOutput.js.map +1 -0
- package/dist/Utils/DetectPackageManager.d.ts +9 -0
- package/dist/Utils/DetectPackageManager.d.ts.map +1 -0
- package/dist/Utils/DetectPackageManager.js +24 -0
- package/dist/Utils/DetectPackageManager.js.map +1 -0
- package/dist/Utils/EnhanceNetworkError.d.ts +14 -0
- package/dist/Utils/EnhanceNetworkError.d.ts.map +1 -0
- package/dist/Utils/EnhanceNetworkError.js +59 -0
- package/dist/Utils/EnhanceNetworkError.js.map +1 -0
- package/dist/Utils/EnvVars.d.ts +17 -0
- package/dist/Utils/EnvVars.d.ts.map +1 -0
- package/dist/Utils/EnvVars.js +38 -0
- package/dist/Utils/EnvVars.js.map +1 -0
- package/dist/Utils/GitCredentialConfig.d.ts +12 -0
- package/dist/Utils/GitCredentialConfig.d.ts.map +1 -0
- package/dist/Utils/GitCredentialConfig.js +32 -0
- package/dist/Utils/GitCredentialConfig.js.map +1 -0
- package/dist/Utils/GitUtils.d.ts +22 -0
- package/dist/Utils/GitUtils.d.ts.map +1 -0
- package/dist/Utils/GitUtils.js +35 -0
- package/dist/Utils/GitUtils.js.map +1 -0
- package/dist/Utils/Paging.d.ts +23 -0
- package/dist/Utils/Paging.d.ts.map +1 -0
- package/dist/Utils/Paging.js +67 -0
- package/dist/Utils/Paging.js.map +1 -0
- package/dist/Utils/ReadPackageJson.d.ts +9 -0
- package/dist/Utils/ReadPackageJson.d.ts.map +1 -0
- package/dist/Utils/ReadPackageJson.js +13 -0
- package/dist/Utils/ReadPackageJson.js.map +1 -0
- package/dist/Utils/ResolveCommand.d.ts +26 -0
- package/dist/Utils/ResolveCommand.d.ts.map +1 -0
- package/dist/Utils/ResolveCommand.js +62 -0
- package/dist/Utils/ResolveCommand.js.map +1 -0
- package/dist/Utils/RunCommand.d.ts +33 -0
- package/dist/Utils/RunCommand.d.ts.map +1 -0
- package/dist/Utils/RunCommand.js +83 -0
- package/dist/Utils/RunCommand.js.map +1 -0
- package/dist/Utils/Spinner.d.ts +15 -0
- package/dist/Utils/Spinner.d.ts.map +1 -0
- package/dist/Utils/Spinner.js +71 -0
- package/dist/Utils/Spinner.js.map +1 -0
- package/dist/Utils/zipBuildArtifact.d.ts +35 -0
- package/dist/Utils/zipBuildArtifact.d.ts.map +1 -0
- package/dist/Utils/zipBuildArtifact.js +100 -0
- package/dist/Utils/zipBuildArtifact.js.map +1 -0
- package/dist/Verbs/AddAction.d.ts +6 -0
- package/dist/Verbs/AddAction.d.ts.map +1 -0
- package/dist/Verbs/AddAction.js +87 -0
- package/dist/Verbs/AddAction.js.map +1 -0
- package/dist/Verbs/AddDataSource.d.ts +19 -0
- package/dist/Verbs/AddDataSource.d.ts.map +1 -0
- package/dist/Verbs/AddDataSource.js +173 -0
- package/dist/Verbs/AddDataSource.js.map +1 -0
- package/dist/Verbs/AddFlow.d.ts +12 -0
- package/dist/Verbs/AddFlow.d.ts.map +1 -0
- package/dist/Verbs/AddFlow.js +67 -0
- package/dist/Verbs/AddFlow.js.map +1 -0
- package/dist/Verbs/AddTable.d.ts +6 -0
- package/dist/Verbs/AddTable.d.ts.map +1 -0
- package/dist/Verbs/AddTable.js +163 -0
- package/dist/Verbs/AddTable.js.map +1 -0
- package/dist/Verbs/AuthStatus.d.ts +6 -0
- package/dist/Verbs/AuthStatus.d.ts.map +1 -0
- package/dist/Verbs/AuthStatus.js +18 -0
- package/dist/Verbs/AuthStatus.js.map +1 -0
- package/dist/Verbs/BuildMaafApp.d.ts +6 -0
- package/dist/Verbs/BuildMaafApp.d.ts.map +1 -0
- package/dist/Verbs/BuildMaafApp.js +96 -0
- package/dist/Verbs/BuildMaafApp.js.map +1 -0
- package/dist/Verbs/ConnectorHelpers.d.ts +37 -0
- package/dist/Verbs/ConnectorHelpers.d.ts.map +1 -0
- package/dist/Verbs/ConnectorHelpers.js +116 -0
- package/dist/Verbs/ConnectorHelpers.js.map +1 -0
- package/dist/Verbs/CreateMaafApp.d.ts +58 -0
- package/dist/Verbs/CreateMaafApp.d.ts.map +1 -0
- package/dist/Verbs/CreateMaafApp.js +712 -0
- package/dist/Verbs/CreateMaafApp.js.map +1 -0
- package/dist/Verbs/DeleteDataSource.d.ts +6 -0
- package/dist/Verbs/DeleteDataSource.d.ts.map +1 -0
- package/dist/Verbs/DeleteDataSource.js +105 -0
- package/dist/Verbs/DeleteDataSource.js.map +1 -0
- package/dist/Verbs/DeleteMaafApp.d.ts +23 -0
- package/dist/Verbs/DeleteMaafApp.d.ts.map +1 -0
- package/dist/Verbs/DeleteMaafApp.js +98 -0
- package/dist/Verbs/DeleteMaafApp.js.map +1 -0
- package/dist/Verbs/DeployMaafApp.d.ts +6 -0
- package/dist/Verbs/DeployMaafApp.d.ts.map +1 -0
- package/dist/Verbs/DeployMaafApp.js +501 -0
- package/dist/Verbs/DeployMaafApp.js.map +1 -0
- package/dist/Verbs/Dev.d.ts +6 -0
- package/dist/Verbs/Dev.d.ts.map +1 -0
- package/dist/Verbs/Dev.js +212 -0
- package/dist/Verbs/Dev.js.map +1 -0
- package/dist/Verbs/FindDataverseApi.d.ts +12 -0
- package/dist/Verbs/FindDataverseApi.d.ts.map +1 -0
- package/dist/Verbs/FindDataverseApi.js +101 -0
- package/dist/Verbs/FindDataverseApi.js.map +1 -0
- package/dist/Verbs/GetMaafApp.d.ts +6 -0
- package/dist/Verbs/GetMaafApp.d.ts.map +1 -0
- package/dist/Verbs/GetMaafApp.js +59 -0
- package/dist/Verbs/GetMaafApp.js.map +1 -0
- package/dist/Verbs/GetMaafBuildStatus.d.ts +6 -0
- package/dist/Verbs/GetMaafBuildStatus.d.ts.map +1 -0
- package/dist/Verbs/GetMaafBuildStatus.js +67 -0
- package/dist/Verbs/GetMaafBuildStatus.js.map +1 -0
- package/dist/Verbs/GetSettings.d.ts +12 -0
- package/dist/Verbs/GetSettings.d.ts.map +1 -0
- package/dist/Verbs/GetSettings.js +48 -0
- package/dist/Verbs/GetSettings.js.map +1 -0
- package/dist/Verbs/Init.d.ts +6 -0
- package/dist/Verbs/Init.d.ts.map +1 -0
- package/dist/Verbs/Init.js +171 -0
- package/dist/Verbs/Init.js.map +1 -0
- package/dist/Verbs/ListConnectionReferences.d.ts +6 -0
- package/dist/Verbs/ListConnectionReferences.d.ts.map +1 -0
- package/dist/Verbs/ListConnectionReferences.js +70 -0
- package/dist/Verbs/ListConnectionReferences.js.map +1 -0
- package/dist/Verbs/ListConnectorActions.d.ts +6 -0
- package/dist/Verbs/ListConnectorActions.d.ts.map +1 -0
- package/dist/Verbs/ListConnectorActions.js +73 -0
- package/dist/Verbs/ListConnectorActions.js.map +1 -0
- package/dist/Verbs/ListConnectors.d.ts +6 -0
- package/dist/Verbs/ListConnectors.d.ts.map +1 -0
- package/dist/Verbs/ListConnectors.js +66 -0
- package/dist/Verbs/ListConnectors.js.map +1 -0
- package/dist/Verbs/ListDatasets.d.ts +6 -0
- package/dist/Verbs/ListDatasets.d.ts.map +1 -0
- package/dist/Verbs/ListDatasets.js +82 -0
- package/dist/Verbs/ListDatasets.js.map +1 -0
- package/dist/Verbs/ListEnvironmentVariables.d.ts +14 -0
- package/dist/Verbs/ListEnvironmentVariables.d.ts.map +1 -0
- package/dist/Verbs/ListEnvironmentVariables.js +66 -0
- package/dist/Verbs/ListEnvironmentVariables.js.map +1 -0
- package/dist/Verbs/ListFlows.d.ts +13 -0
- package/dist/Verbs/ListFlows.d.ts.map +1 -0
- package/dist/Verbs/ListFlows.js +88 -0
- package/dist/Verbs/ListFlows.js.map +1 -0
- package/dist/Verbs/ListMaafApps.d.ts +71 -0
- package/dist/Verbs/ListMaafApps.d.ts.map +1 -0
- package/dist/Verbs/ListMaafApps.js +168 -0
- package/dist/Verbs/ListMaafApps.js.map +1 -0
- package/dist/Verbs/ListSqlStoredProcedures.d.ts +6 -0
- package/dist/Verbs/ListSqlStoredProcedures.d.ts.map +1 -0
- package/dist/Verbs/ListSqlStoredProcedures.js +84 -0
- package/dist/Verbs/ListSqlStoredProcedures.js.map +1 -0
- package/dist/Verbs/ListTables.d.ts +6 -0
- package/dist/Verbs/ListTables.d.ts.map +1 -0
- package/dist/Verbs/ListTables.js +94 -0
- package/dist/Verbs/ListTables.js.map +1 -0
- package/dist/Verbs/Login.d.ts +6 -0
- package/dist/Verbs/Login.d.ts.map +1 -0
- package/dist/Verbs/Login.js +28 -0
- package/dist/Verbs/Login.js.map +1 -0
- package/dist/Verbs/Logout.d.ts +6 -0
- package/dist/Verbs/Logout.d.ts.map +1 -0
- package/dist/Verbs/Logout.js +28 -0
- package/dist/Verbs/Logout.js.map +1 -0
- package/dist/Verbs/MaafAppPermissions.d.ts +23 -0
- package/dist/Verbs/MaafAppPermissions.d.ts.map +1 -0
- package/dist/Verbs/MaafAppPermissions.js +278 -0
- package/dist/Verbs/MaafAppPermissions.js.map +1 -0
- package/dist/Verbs/Pack.d.ts +42 -0
- package/dist/Verbs/Pack.d.ts.map +1 -0
- package/dist/Verbs/Pack.js +114 -0
- package/dist/Verbs/Pack.js.map +1 -0
- package/dist/Verbs/RefreshDataSource.d.ts +6 -0
- package/dist/Verbs/RefreshDataSource.d.ts.map +1 -0
- package/dist/Verbs/RefreshDataSource.js +72 -0
- package/dist/Verbs/RefreshDataSource.js.map +1 -0
- package/dist/Verbs/RemoveFlow.d.ts +12 -0
- package/dist/Verbs/RemoveFlow.d.ts.map +1 -0
- package/dist/Verbs/RemoveFlow.js +99 -0
- package/dist/Verbs/RemoveFlow.js.map +1 -0
- package/dist/Verbs/SetSetting.d.ts +12 -0
- package/dist/Verbs/SetSetting.d.ts.map +1 -0
- package/dist/Verbs/SetSetting.js +141 -0
- package/dist/Verbs/SetSetting.js.map +1 -0
- package/dist/Verbs/ShareMaafApp.d.ts +12 -0
- package/dist/Verbs/ShareMaafApp.d.ts.map +1 -0
- package/dist/Verbs/ShareMaafApp.js +14 -0
- package/dist/Verbs/ShareMaafApp.js.map +1 -0
- package/dist/Verbs/ShowMaafApp.d.ts +94 -0
- package/dist/Verbs/ShowMaafApp.d.ts.map +1 -0
- package/dist/Verbs/ShowMaafApp.js +216 -0
- package/dist/Verbs/ShowMaafApp.js.map +1 -0
- package/dist/Verbs/TelemetrySettings.d.ts +8 -0
- package/dist/Verbs/TelemetrySettings.d.ts.map +1 -0
- package/dist/Verbs/TelemetrySettings.js +104 -0
- package/dist/Verbs/TelemetrySettings.js.map +1 -0
- package/dist/Verbs/UnshareMaafApp.d.ts +12 -0
- package/dist/Verbs/UnshareMaafApp.d.ts.map +1 -0
- package/dist/Verbs/UnshareMaafApp.js +14 -0
- package/dist/Verbs/UnshareMaafApp.js.map +1 -0
- package/dist/Verbs/VerbConstants.d.ts +415 -0
- package/dist/Verbs/VerbConstants.d.ts.map +1 -0
- package/dist/Verbs/VerbConstants.js +382 -0
- package/dist/Verbs/VerbConstants.js.map +1 -0
- package/dist/Verbs/index.d.ts +39 -0
- package/dist/Verbs/index.d.ts.map +1 -0
- package/dist/Verbs/index.js +39 -0
- package/dist/Verbs/index.js.map +1 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
MICROSOFT SOFTWARE LICENSE TERMS
|
|
2
|
+
MICROSOFT POWER PLATFORM – @MICROSOFT/APPS-CLI
|
|
3
|
+
|
|
4
|
+
August 2025
|
|
5
|
+
These license terms are an agreement between you and Microsoft Corporation (or one of its affiliates). They
|
|
6
|
+
apply to the software named above and any Microsoft services or software updates (except to the extent such
|
|
7
|
+
services or updates are accompanied by new or additional terms, in which case those different terms apply
|
|
8
|
+
prospectively and do not alter your or Microsoft's rights relating to pre-updated software or services). IF YOU
|
|
9
|
+
COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW. BY USING THE SOFTWARE, YOU
|
|
10
|
+
ACCEPT THESE TERMS.
|
|
11
|
+
1. INSTALLATION AND USE RIGHTS.
|
|
12
|
+
a) General. You may install and use any number of copies of the software to develop and test your
|
|
13
|
+
applications.
|
|
14
|
+
b) Third Party Components. The software may include third party components with separate legal
|
|
15
|
+
notices or governed by other agreements, as may be described in the ThirdPartyNotices file(s)
|
|
16
|
+
accompanying the software.
|
|
17
|
+
c) Work or School Accounts. You can sign into the software with a work or school email address. If
|
|
18
|
+
you do, you agree that the owner of the domain associated with your email address may control and
|
|
19
|
+
administer your account, and access and process your data, including the contents of your
|
|
20
|
+
communications and files. You further agree that your use of the software may be subject to: i) your
|
|
21
|
+
organization's guidelines and policies regarding the use of the software; and ii) the agreements
|
|
22
|
+
Microsoft has with you or your organization, and in such case these terms may not apply. If you
|
|
23
|
+
already have a Microsoft account and you use a separate work or school email address to access the
|
|
24
|
+
software, you may be prompted to update the email address associated with your Microsoft account to
|
|
25
|
+
continue accessing the software.
|
|
26
|
+
2. SCOPE OF LICENSE. The software is licensed, not sold. Microsoft reserves all other rights. Unless
|
|
27
|
+
applicable law gives you more rights despite this limitation, you will not (and have no right to):
|
|
28
|
+
a) work around any technical limitations in the software that only allow you to use it in certain ways;
|
|
29
|
+
b) reverse engineer, decompile or disassemble the software, or otherwise attempt to derive the source
|
|
30
|
+
code for the software, except and to the extent required by third party licensing terms governing use
|
|
31
|
+
of certain open source components that may be included in the software;
|
|
32
|
+
c) remove, minimize, block, or modify any notices of Microsoft or its suppliers in the software;
|
|
33
|
+
d) use the software in any way that is against the law or to create or propagate malware; or
|
|
34
|
+
e) share, publish, distribute, or lease the software (except for any distributable code, subject to the
|
|
35
|
+
terms above), provide the software as a stand-alone offering for others to use, or transfer the
|
|
36
|
+
software or this agreement to any third party.
|
|
37
|
+
3. DATA.
|
|
38
|
+
a) Data Collection. The software may collect information about you and your use of the software, and
|
|
39
|
+
send that to Microsoft. Microsoft may use this information to provide services and improve our
|
|
40
|
+
products and services. You may opt-out of many of these scenarios, but not all, as described in the
|
|
41
|
+
product documentation. There are also some features in the software that may enable you to collect
|
|
42
|
+
data from users of your applications. If you use these features to enable data collection in your
|
|
43
|
+
applications, you must comply with applicable law, including providing appropriate notices to users of
|
|
44
|
+
your applications. You can learn more about data collection and use in the help documentation and
|
|
45
|
+
the privacy statement at https://go.microsoft.com/fwlink/?linkid=521839. Your use of the software
|
|
46
|
+
operates as your consent to these practices.
|
|
47
|
+
b) Processing of Personal Data. To the extent Microsoft is a processor or subprocessor of personal
|
|
48
|
+
data in connection with the software, Microsoft makes the commitments in the European Union
|
|
49
|
+
General Data Protection Regulation Terms of the Microsoft Products and Services Data Protection
|
|
50
|
+
Addendum to all customers effective May 25, 2018, at
|
|
51
|
+
https://go.microsoft.com/fwlink/?linkid=2135030.
|
|
52
|
+
4. COMPLIANCE WITH TRADE LAWS. Microsoft products, software, technology, and services ("Items")
|
|
53
|
+
may be subject to U.S. and other countries' export jurisdictions. Each party will comply with all laws and
|
|
54
|
+
regulations applicable to the import or export of the Items, including, without limitation, trade laws of the
|
|
55
|
+
U.S., EU, and UK, such as the U.S. Export Administration Regulations, sanctions regulations administered
|
|
56
|
+
by the U.S. Office of Foreign Assets Control, the EU Dual Use Regulation 2021/821, and/or other end-user,
|
|
57
|
+
end use, and destination restrictions ("Trade Laws") as well as the global legal compliance standards
|
|
58
|
+
detailed in the Microsoft Standards of Business Conduct. Customer will not, and will ensure its Affiliates
|
|
59
|
+
will not, take any action that causes Microsoft to violate applicable Trade Laws. Microsoft may suspend or
|
|
60
|
+
terminate this agreement immediately without notice to the extent that Microsoft reasonably believes that
|
|
61
|
+
performance would cause it to violate Trade Laws or put it at risk of becoming subject to sanctions and
|
|
62
|
+
penalties under such laws. Customer remains responsible for its and for its Affiliates' compliance with this
|
|
63
|
+
section and, to the extent applicable, the Regional Trade Compliance Addendum incorporated herein by
|
|
64
|
+
reference.
|
|
65
|
+
5. SUPPORT SERVICES. Microsoft is not obligated under this agreement to provide any support services for
|
|
66
|
+
the software. Any support provided is "as is", "with all faults", and without warranty of any kind.
|
|
67
|
+
6. ENTIRE AGREEMENT. This agreement, and any other terms Microsoft may provide for supplements,
|
|
68
|
+
updates, or third-party applications, is the entire agreement for the software.
|
|
69
|
+
7. APPLICABLE LAW AND PLACE TO RESOLVE DISPUTES. If you acquired the software in the United
|
|
70
|
+
States or Canada, the laws of the state or province where you live (or, if a business, where your principal
|
|
71
|
+
place of business is located) govern the interpretation of this agreement, claims for its breach, and all
|
|
72
|
+
other claims (including consumer protection, unfair competition, and tort claims), regardless of conflict of
|
|
73
|
+
laws principles. If you acquired the software in any other country, its laws apply. If U.S. federal jurisdiction
|
|
74
|
+
exists, you and Microsoft consent to exclusive jurisdiction and venue in the federal court in King County,
|
|
75
|
+
Washington for all disputes heard in court. If not, you and Microsoft consent to exclusive jurisdiction and
|
|
76
|
+
venue in the Superior Court of King County, Washington for all disputes heard in court.
|
|
77
|
+
8. CONSUMER RIGHTS; REGIONAL VARIATIONS. This agreement describes certain legal rights. You
|
|
78
|
+
may have other rights, including consumer rights, under the laws of your state or country. Separate and
|
|
79
|
+
apart from your relationship with Microsoft, you may also have rights with respect to the party from which
|
|
80
|
+
you acquired the software. This agreement does not change those other rights if the laws of your state or
|
|
81
|
+
country do not permit it to do so. For example, if you acquired the software in one of the below regions, or
|
|
82
|
+
mandatory country law applies, then the following provisions apply to you:
|
|
83
|
+
a) Australia. You have statutory guarantees under the Australian Consumer Law and nothing in this
|
|
84
|
+
agreement is intended to affect those rights.
|
|
85
|
+
b) Canada. If you acquired this software in Canada, you may stop receiving updates by turning off the
|
|
86
|
+
automatic update feature, disconnecting your device from the Internet (if and when you re-connect to
|
|
87
|
+
the Internet, however, the software will resume checking for and installing updates), or uninstalling
|
|
88
|
+
the software. The product documentation, if any, may also specify how to turn off updates for your
|
|
89
|
+
specific device or software.
|
|
90
|
+
c) Germany and Austria.
|
|
91
|
+
i. Warranty. The properly licensed software will perform substantially as described in any Microsoft
|
|
92
|
+
materials that accompany the software. However, Microsoft gives no contractual guarantee in
|
|
93
|
+
relation to the licensed software.
|
|
94
|
+
ii. Limitation of Liability. In case of intentional conduct, gross negligence, claims based on the
|
|
95
|
+
Product Liability Act, as well as, in case of death or personal or physical injury, Microsoft is liable
|
|
96
|
+
according to the statutory law.
|
|
97
|
+
Subject to the foregoing clause ii., Microsoft will only be liable for slight negligence if Microsoft is in
|
|
98
|
+
breach of such material contractual obligations, the fulfillment of which facilitate the due performance
|
|
99
|
+
of this agreement, the breach of which would endanger the purpose of this agreement and the
|
|
100
|
+
compliance with which a party may constantly trust in (so-called "cardinal obligations"). In other cases
|
|
101
|
+
of slight negligence, Microsoft will not be liable for slight negligence.
|
|
102
|
+
9. DISCLAIMER OF WARRANTY. THE SOFTWARE IS LICENSED "AS IS." YOU BEAR THE RISK OF
|
|
103
|
+
USING IT. MICROSOFT GIVES NO EXPRESS WARRANTIES, GUARANTEES, OR CONDITIONS.
|
|
104
|
+
TO THE EXTENT PERMITTED UNDER APPLICABLE LAWS, MICROSOFT EXCLUDES ALL IMPLIED
|
|
105
|
+
WARRANTIES, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
|
|
106
|
+
NON-INFRINGEMENT.
|
|
107
|
+
10. LIMITATION ON AND EXCLUSION OF DAMAGES. IF YOU HAVE ANY BASIS FOR RECOVERING
|
|
108
|
+
DAMAGES DESPITE THE PRECEDING DISCLAIMER OF WARRANTY, YOU CAN RECOVER FROM
|
|
109
|
+
MICROSOFT AND ITS SUPPLIERS ONLY DIRECT DAMAGES UP TO U.S. $5.00. YOU CANNOT
|
|
110
|
+
RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, LOST PROFITS, SPECIAL,
|
|
111
|
+
INDIRECT, OR INCIDENTAL DAMAGES.
|
|
112
|
+
This limitation applies to (a) anything related to the software, services, content (including
|
|
113
|
+
code) on third party Internet sites, or third party applications; and (b) claims for breach of
|
|
114
|
+
contract, warranty, guarantee, or condition; strict liability, negligence, or other tort; or any
|
|
115
|
+
other claim; in each case to the extent permitted by applicable law.
|
|
116
|
+
It also applies even if Microsoft knew or should have known about the possibility of the
|
|
117
|
+
damages. The above limitation or exclusion may not apply to you because your state,
|
|
118
|
+
province, or country may not allow the exclusion or limitation of incidental, consequential, or
|
|
119
|
+
other damages.
|
|
120
|
+
|
|
121
|
+
Please note: As this software is distributed in Canada, some of the clauses in this agreement are
|
|
122
|
+
provided below in French.
|
|
123
|
+
Remarque: Ce logiciel étant distribué au Canada, certaines des clauses dans ce contrat sont
|
|
124
|
+
fournies ci-dessous en français.
|
|
125
|
+
EXONÉRATION DE GARANTIE. Le logiciel visé par une licence est offert « tel quel ». Toute
|
|
126
|
+
utilisation de ce logiciel est à votre seule risque et péril. Microsoft n'accorde aucune autre
|
|
127
|
+
garantie expresse. Vous pouvez bénéficier de droits additionnels en vertu du droit local sur la
|
|
128
|
+
protection des consommateurs, que ce contrat ne peut modifier. La ou elles sont permises par le
|
|
129
|
+
droit locale, les garanties implicites de qualité marchande, d'adéquation à un usage particulier et
|
|
130
|
+
d'absence de contrefaçon sont exclues.
|
|
131
|
+
LIMITATION DES DOMMAGES-INTÉRÊTS ET EXCLUSION DE RESPONSABILITÉ POUR LES
|
|
132
|
+
DOMMAGES. Vous pouvez obtenir de Microsoft et de ses fournisseurs une indemnisation en cas de
|
|
133
|
+
dommages directs uniquement à hauteur de 5,00 $ US. Vous ne pouvez prétendre à aucune
|
|
134
|
+
indemnisation pour les autres dommages, y compris les dommages spéciaux, indirects ou
|
|
135
|
+
accessoires et pertes de bénéfices.
|
|
136
|
+
Cette limitation concerne:
|
|
137
|
+
• tout ce qui est relié au logiciel, aux services ou au contenu (y compris le code) figurant sur
|
|
138
|
+
des sites Internet tiers ou dans des programmes tiers; et
|
|
139
|
+
• les réclamations au titre de violation de contrat ou de garantie, ou au titre de responsabilité
|
|
140
|
+
stricte, de négligence ou d'une autre faute dans la limite autorisée par la loi en vigueur.
|
|
141
|
+
Elle s'applique également, même si Microsoft connaissait ou devrait connaître l'éventualité d'un
|
|
142
|
+
tel dommage. Si votre pays n'autorise pas l'exclusion ou la limitation de responsabilité pour les
|
|
143
|
+
dommages indirects, accessoires ou de quelque nature que ce soit, il se peut que la limitation ou
|
|
144
|
+
l'exclusion ci-dessus ne s'appliquera pas à votre égard.
|
|
145
|
+
EFFET JURIDIQUE. Le présent contrat décrit certains droits juridiques. Vous pourriez avoir
|
|
146
|
+
d'autres droits prévus par les lois de votre pays. Le présent contrat ne modifie pas les droits que
|
|
147
|
+
vous confèrent les lois de votre pays si celles-ci ne le permettent pas.
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
DWT 28909173v1 0085000-001126
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
DWT 28909173v1 0085000-001126
|
package/README.md
ADDED
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
# @microsoft/managed-apps-cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for the Microsoft Apps (MAAF) platform. Manage app lifecycle, sharing, and developer workflows from your terminal.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install --save-dev @microsoft/managed-apps-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
After installation, run commands using:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx ms <command>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx ms app <verb> [options]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
You can pass options on the command line, set them via environment variables (see each verb's `envVar` mapping), or in interactive mode let the CLI prompt for missing values.
|
|
24
|
+
|
|
25
|
+
## Commands
|
|
26
|
+
|
|
27
|
+
### `app create`
|
|
28
|
+
|
|
29
|
+
Create a new MAAF app in the environment. Initializes a local git repo and scaffolds the app into `apps/<server-app-guid>`.
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npx ms app create --display-name "My App" --repository-id <id>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### `app init`
|
|
36
|
+
|
|
37
|
+
Initialize a `ms.config.json` for an existing app.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx ms app init --display-name "My App" --environment-id <id>
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### `app list`
|
|
44
|
+
|
|
45
|
+
List all code apps in the environment.
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npx ms app list
|
|
49
|
+
npx ms app list --json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### `app show`
|
|
53
|
+
|
|
54
|
+
Show the current app's configuration and bound resources (connectors, tables, procedures).
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npx ms app show
|
|
58
|
+
npx ms app show --json
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### `app info`
|
|
62
|
+
|
|
63
|
+
Fetch metadata for an app from the platform.
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
npx ms app info --app my-app
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `app build` / `app build-status`
|
|
70
|
+
|
|
71
|
+
Initiate a cloud build for a MAAF app and poll its status.
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npx ms app build --app my-app --commit abc1234
|
|
75
|
+
npx ms app build-status --app my-app --operation-id <id>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### `app deploy`
|
|
79
|
+
|
|
80
|
+
Deploy an app version to its environment. The behavior depends on the app's `repoType` recorded in `ms.config.json`:
|
|
81
|
+
|
|
82
|
+
- **`native` / `github` (git-backed)** — Queues a remote build for the chosen commit (defaults to current `HEAD`; override with `--commit`), waits for it to complete, and deploys the result. Warns if the working tree has uncommitted changes.
|
|
83
|
+
- **`none` (external artifact)** — When `--artifact` is omitted, runs `pack` to produce a local bundle, zips it, uploads it, and deploys the synthetic commit. When `--artifact <path>` is supplied, uploads the provided `.zip` directly without running `pack`.
|
|
84
|
+
|
|
85
|
+
`--artifact <path>` is **only valid for apps created with `repoType: 'none'`**. Using it on a git-backed (`native` / `github`) app is rejected as a `UsageError`. `--commit` and `--artifact` are mutually exclusive, and `--commit` is rejected on `repoType: 'none'` apps (no git repo to resolve from).
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npx ms app deploy
|
|
89
|
+
npx ms app deploy --app my-app --commit abc1234
|
|
90
|
+
npx ms app deploy --artifact ./build.zip
|
|
91
|
+
npx ms app deploy --app my-app --commit abc1234 --json
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### `app pack`
|
|
95
|
+
|
|
96
|
+
Run the app's build command and copy the output to `.ms/packed/apps/<appId>/client/` for offline or manual deployment. Requires `appId`, `buildPath`, and `buildCommand` to be set in `ms.config.json`.
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
npx ms app pack
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### `app dev`
|
|
103
|
+
|
|
104
|
+
Run the app locally. Starts the dev script and a config server (default port 8080) that serves `ms.config.json` to the App Player. See [`docs/architecture/packages/managed-apps-cli/dev-command.md`](../../docs/architecture/packages/managed-apps-cli/dev-command.md) for the two-server design.
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
npx ms app dev
|
|
108
|
+
npx ms app dev --port 8080 --local-app-url http://localhost:3000
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### `app delete`
|
|
112
|
+
|
|
113
|
+
Soft-delete a MAAF app. The server distinguishes "found and deleted" from "did not exist"; the CLI surfaces the latter as a warning rather than an error so the verb is safe to run idempotently in automation.
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# Delete the app from the current ms.config.json directory
|
|
117
|
+
npx ms app delete
|
|
118
|
+
|
|
119
|
+
# Override the app name (env id still comes from ms.config.json)
|
|
120
|
+
npx ms app delete --app my-app
|
|
121
|
+
|
|
122
|
+
# Delete an app from outside its scaffolded directory by overriding both
|
|
123
|
+
npx ms app delete --app my-app --environment-id <id>
|
|
124
|
+
|
|
125
|
+
# Skip the "are you sure?" confirmation (CI mode is implicitly non-interactive)
|
|
126
|
+
npx ms app delete --force
|
|
127
|
+
|
|
128
|
+
# JSON output: { "appName": "...", "existed": true | false }
|
|
129
|
+
npx ms app delete --json --force
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
In interactive mode the verb prompts for confirmation before deleting. `--force`/`-f` skips the prompt.
|
|
133
|
+
|
|
134
|
+
### `app share` / `app unshare`
|
|
135
|
+
|
|
136
|
+
Share or unshare a MAAF app with users and groups. `share` grants the `Microsoft App Reader` role at the app scope; `unshare` revokes all role assignments at that scope. Both verbs take a comma-separated positional list of principals — each entry is either a Microsoft Entra object ID (GUID) or an email address. Emails are resolved against your tenant via Microsoft Graph (`User.ReadBasic.All` and `Group.Read.All`).
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
# Share by email (resolved via Graph)
|
|
140
|
+
npx ms app share alice@contoso.com,bob@contoso.com
|
|
141
|
+
|
|
142
|
+
# Share by AAD object id
|
|
143
|
+
npx ms app share 11111111-1111-4111-8111-111111111111
|
|
144
|
+
|
|
145
|
+
# Unshare by email or id
|
|
146
|
+
npx ms app unshare alice@contoso.com
|
|
147
|
+
npx ms app unshare 22222222-2222-4222-8222-222222222222
|
|
148
|
+
|
|
149
|
+
# Override the app name from ms.config.json
|
|
150
|
+
npx ms app share --app my-app alice@contoso.com
|
|
151
|
+
|
|
152
|
+
# JSON output for piping into other tools
|
|
153
|
+
npx ms app unshare alice@contoso.com --json
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
If some entries can't be resolved (typo'd email, unsupported principal type, or insufficient Graph permissions), they're listed as a warning and the operation proceeds for the resolvable subset. If nothing resolves, the verb errors out with the per-entry reasons.
|
|
157
|
+
|
|
158
|
+
In `--json` mode the output is an envelope so automation can detect partial success without parsing stderr:
|
|
159
|
+
|
|
160
|
+
```json
|
|
161
|
+
{
|
|
162
|
+
"result": {
|
|
163
|
+
"put": [
|
|
164
|
+
/* server response */
|
|
165
|
+
]
|
|
166
|
+
},
|
|
167
|
+
"warnings": [
|
|
168
|
+
{ "input": "unknown@contoso.com", "reason": "no user or group found in this tenant ..." }
|
|
169
|
+
]
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
`warnings` is always present (empty array on full success).
|
|
174
|
+
|
|
175
|
+
### `app refresh`
|
|
176
|
+
|
|
177
|
+
Refresh data sources in the current app.
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
npx ms app refresh
|
|
181
|
+
npx ms app refresh --data-source-name contact
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### `app add action` / `app add table` / `app add procedure` / `app remove table` / `app remove procedure`
|
|
185
|
+
|
|
186
|
+
Bind or unbind data sources (connector actions, Dataverse tables, SQL stored procedures, etc.) to the app. `app add action` adds a non-tabular connector (e.g. Office 365); `app add table` adds a tabular connector data source. Both verbs run a DLP preflight, prompt for a connection when `--connection-id` is omitted, and offer to create one for you. Use `--skip-codegen` to skip TypeScript regeneration.
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
npx ms app add action --api-id shared_office365
|
|
190
|
+
npx ms app add action --api-id shared_sql --connection-id <id>
|
|
191
|
+
npx ms app add table --api-id shared_sql --connection-id <id> --dataset <db> --table <tbl>
|
|
192
|
+
npx ms app add procedure --api-id shared_sql --connection-id <id> --dataset <db>
|
|
193
|
+
npx ms app remove table --api-id dataverse --data-source-name contact --force
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### `app set-setting` / `app get-settings`
|
|
197
|
+
|
|
198
|
+
Read and write app settings stored in `ms.config.json`.
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
npx ms app get-settings
|
|
202
|
+
npx ms app set-setting --show-header false
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### `connector list-actions`
|
|
206
|
+
|
|
207
|
+
Search Dataverse actions and functions in the environment by name.
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
npx ms connector list-actions --search "account"
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### `auth login`
|
|
214
|
+
|
|
215
|
+
Sign in interactively using MSAL (opens the system browser). Optionally pass `--hint` to pre-fill the username.
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
npx ms auth login
|
|
219
|
+
npx ms auth login --hint alice@contoso.com
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
On success prints `Signed in as <email>`.
|
|
223
|
+
|
|
224
|
+
### `auth status`
|
|
225
|
+
|
|
226
|
+
Print the currently signed-in account (or a prompt to run `auth login` if not signed in).
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
npx ms auth status
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### `auth logout`
|
|
233
|
+
|
|
234
|
+
Remove the cached Entra ID account.
|
|
235
|
+
|
|
236
|
+
```bash
|
|
237
|
+
npx ms auth logout
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### `telemetry enable` / `telemetry disable` / `telemetry status`
|
|
241
|
+
|
|
242
|
+
Manage CLI telemetry settings.
|
|
243
|
+
|
|
244
|
+
```bash
|
|
245
|
+
npx ms telemetry status
|
|
246
|
+
npx ms telemetry disable --console
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
## Configuration
|
|
250
|
+
|
|
251
|
+
The CLI reads configuration from `ms.config.json` in the current directory. Notable fields:
|
|
252
|
+
|
|
253
|
+
- `appId` — Server-side app identifier; consumed by `app show`, `app deploy`, `app share`, `app unshare`, etc. when `--app` is omitted.
|
|
254
|
+
- `environmentId` — The target environment. Resolved config-first, then `--environment-id`.
|
|
255
|
+
|
|
256
|
+
## Global options
|
|
257
|
+
|
|
258
|
+
| Option | Alias | Description |
|
|
259
|
+
| ------------------- | ----- | --------------------------------------------------------------------- |
|
|
260
|
+
| `--cloud` | | Cloud instance to use (e.g. `prod`, `gccmoderate`, `gcchigh`, `dod`). |
|
|
261
|
+
| `--environment-id` | `-e` | Environment ID to connect to. |
|
|
262
|
+
| `--non-interactive` | | Run without interactive prompts (all parameters must be provided). |
|
|
263
|
+
| `--json` | | Format output as JSON. |
|
|
264
|
+
| `--no-color` | | Disable coloured output. |
|
|
265
|
+
|
|
266
|
+
## Telemetry
|
|
267
|
+
|
|
268
|
+
CLI events are tagged with `clientType: NodeCLI` (or `PacCLI` when invoked through `pac`) and prefixed `MicrosoftAppsCLI.`. Disable transmission with `npx ms telemetry disable`.
|
|
269
|
+
|
|
270
|
+
## Design Docs
|
|
271
|
+
|
|
272
|
+
The product spec for this CLI lives in [`docs/specs/managed-apps-cli/`](../../docs/specs/managed-apps-cli/):
|
|
273
|
+
|
|
274
|
+
| File | Covers |
|
|
275
|
+
| --------------------- | ------------------------------------------------------------------------------------- |
|
|
276
|
+
| `principles.md` | Seven design principles in priority order — the rules that govern every CLI decision |
|
|
277
|
+
| `style-guidelines.md` | Command structure, naming conventions, output/error format, help text format |
|
|
278
|
+
| `commands.md` | Full command reference: required flags, optional flags, and purpose for every command |
|
|
279
|
+
|
|
280
|
+
**When contributing**: if you add a command, rename a flag, or change observable behavior, update `commands.md` (and `style-guidelines.md` if you introduce a new convention). The spec is the authoritative user-facing reference and must stay in sync with the code.
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (C) Microsoft Corporation. All rights reserved.
|
|
3
|
+
*/
|
|
4
|
+
import type { IHttpClient } from '@microsoft/managed-apps-actions';
|
|
5
|
+
import { type Cloud } from '@microsoft/managed-apps-common/services';
|
|
6
|
+
import type { CliLogger } from './Logger/CliLogger.js';
|
|
7
|
+
import type { CliOption } from './Types/Argument.types.js';
|
|
8
|
+
import type { IAuthenticationProvider } from './Types/Cli.types.js';
|
|
9
|
+
import type { ResolvedCommand } from './Types/Command.types.js';
|
|
10
|
+
export interface IArgumentProvider {
|
|
11
|
+
addOption(cliOption: CliOption): void;
|
|
12
|
+
addOptions(cliOptions: CliOption[]): void;
|
|
13
|
+
addSwitch(cliOption: CliOption): void;
|
|
14
|
+
addSwitches(cliOptions: CliOption[]): void;
|
|
15
|
+
consumePositionalArg(name: string): void;
|
|
16
|
+
getPositionalArg(index: number): string | undefined;
|
|
17
|
+
runVerb(): Promise<void>;
|
|
18
|
+
getVerb(): string;
|
|
19
|
+
getResolvedCommand(): ResolvedCommand | null;
|
|
20
|
+
handleGlobalHelpOrFlagsAndExit(): void;
|
|
21
|
+
getOption<T>(key: string, ignorePrompt?: boolean): Promise<T>;
|
|
22
|
+
getAuthenticationProvider(): IAuthenticationProvider;
|
|
23
|
+
getHttpClient(): IHttpClient;
|
|
24
|
+
getTenantIdAsync(): Promise<string | undefined>;
|
|
25
|
+
getAuthResourceUrl(): string;
|
|
26
|
+
getLoginAuthority(tenantId: string): string;
|
|
27
|
+
setDescription(description: string): void;
|
|
28
|
+
isJsonMode(): boolean;
|
|
29
|
+
addExamples(examples: string[]): void;
|
|
30
|
+
/** Returns all `--flag` tokens currently registered with the program (including short aliases). */
|
|
31
|
+
getRegisteredFlags(): ReadonlySet<string>;
|
|
32
|
+
/** Returns the validated, normalized user-facing cloud value (from --cloud or ms.config.json). */
|
|
33
|
+
getCloud(): Cloud | undefined;
|
|
34
|
+
}
|
|
35
|
+
export declare class ArgumentProvider implements IArgumentProvider {
|
|
36
|
+
private _httpClient;
|
|
37
|
+
private _logger;
|
|
38
|
+
private _authenticationProvider;
|
|
39
|
+
private _environmentId;
|
|
40
|
+
private _cloud;
|
|
41
|
+
private _region;
|
|
42
|
+
private _verb;
|
|
43
|
+
private _resolvedCommand;
|
|
44
|
+
private _tokensConsumed;
|
|
45
|
+
private _program;
|
|
46
|
+
private _options;
|
|
47
|
+
private _positionalArgs;
|
|
48
|
+
private _positionalArgNames;
|
|
49
|
+
private _isParsed;
|
|
50
|
+
constructor(_httpClient: IHttpClient, _logger: CliLogger, _authenticationProvider: IAuthenticationProvider);
|
|
51
|
+
addSwitch(cliOption: CliOption): void;
|
|
52
|
+
addSwitches(cliOptions: CliOption[]): void;
|
|
53
|
+
/**
|
|
54
|
+
* Consumes the next positional token from process.argv before Commander parses flags.
|
|
55
|
+
* Increments the internal token counter so runVerb() excludes this token from Commander's
|
|
56
|
+
* args, and updates the usage string so --help shows the argument name.
|
|
57
|
+
*
|
|
58
|
+
* Must be called before runVerb().
|
|
59
|
+
*/
|
|
60
|
+
consumePositionalArg(name: string): void;
|
|
61
|
+
getPositionalArg(index: number): string | undefined;
|
|
62
|
+
addOption(cliOption: CliOption): void;
|
|
63
|
+
addOptions(cliOptions: CliOption[]): void;
|
|
64
|
+
runVerb(): Promise<void>;
|
|
65
|
+
handleGlobalHelpOrFlagsAndExit(): void;
|
|
66
|
+
getVerb(): string;
|
|
67
|
+
getResolvedCommand(): ResolvedCommand | null;
|
|
68
|
+
getOption<T>(key: string, ignorePrompt?: boolean): Promise<T>;
|
|
69
|
+
getAuthenticationProvider(): IAuthenticationProvider;
|
|
70
|
+
getHttpClient(): IHttpClient;
|
|
71
|
+
/**
|
|
72
|
+
* Returns the tenant ID for the authenticated user, acquiring a token first if needed.
|
|
73
|
+
*
|
|
74
|
+
* NodeMsalAuthenticationProvider only populates _tenantId after getAccessTokenForResource()
|
|
75
|
+
* is called. This method pre-acquires a token for the Power Platform resource so the tenant
|
|
76
|
+
* ID is always available after runVerb() completes.
|
|
77
|
+
*/
|
|
78
|
+
getTenantIdAsync(): Promise<string | undefined>;
|
|
79
|
+
getAuthResourceUrl(): string;
|
|
80
|
+
getCloud(): Cloud | undefined;
|
|
81
|
+
getLoginAuthority(tenantId: string): string;
|
|
82
|
+
/**
|
|
83
|
+
* Sets the description for the current command context.
|
|
84
|
+
* This is used to display help information specific to the verb being executed.
|
|
85
|
+
*
|
|
86
|
+
* @param {string} description - The description to set for the program.
|
|
87
|
+
*/
|
|
88
|
+
setDescription(description: string): void;
|
|
89
|
+
isJsonMode(): boolean;
|
|
90
|
+
addExamples(examples: string[]): void;
|
|
91
|
+
getRegisteredFlags(): ReadonlySet<string>;
|
|
92
|
+
getEnvironmentId(): string | undefined;
|
|
93
|
+
private _getRequiredVariables;
|
|
94
|
+
/**
|
|
95
|
+
* @param {CliOption} cliOption
|
|
96
|
+
* @param {boolean} [hasValue=true] true if the option requires a value, false for a switch such as --help
|
|
97
|
+
*/
|
|
98
|
+
private _createOption;
|
|
99
|
+
private _createFlags;
|
|
100
|
+
private _createSwitchFlags;
|
|
101
|
+
}
|
|
102
|
+
//# sourceMappingURL=ArgumentProvider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ArgumentProvider.d.ts","sourceRoot":"","sources":["../src/ArgumentProvider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EACL,KAAK,KAAK,EAKX,MAAM,yCAAyC,CAAC;AAUjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAS,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAW7D,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IACtC,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC1C,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IACtC,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC3C,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACpD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,IAAI,MAAM,CAAC;IAClB,kBAAkB,IAAI,eAAe,GAAG,IAAI,CAAC;IAC7C,8BAA8B,IAAI,IAAI,CAAC;IACvC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC9D,yBAAyB,IAAI,uBAAuB,CAAC;IACrD,aAAa,IAAI,WAAW,CAAC;IAC7B,gBAAgB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAChD,kBAAkB,IAAI,MAAM,CAAC;IAC7B,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,UAAU,IAAI,OAAO,CAAC;IACtB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACtC,mGAAmG;IACnG,kBAAkB,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IAC1C,kGAAkG;IAClG,QAAQ,IAAI,KAAK,GAAG,SAAS,CAAC;CAC/B;AAED,qBAAa,gBAAiB,YAAW,iBAAiB;IActD,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,uBAAuB;IAfjC,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,eAAe,CAAiC;IACxD,OAAO,CAAC,mBAAmB,CAAgB;IAC3C,OAAO,CAAC,SAAS,CAAS;gBAGhB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,SAAS,EAClB,uBAAuB,EAAE,uBAAuB;IAyFnD,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAIrC,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI;IAIjD;;;;;;OAMG;IACI,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAaxC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAInD,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAIrC,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI;IAInC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAmC9B,8BAA8B;IAuD9B,OAAO,IAAI,MAAM;IASjB,kBAAkB,IAAI,eAAe,GAAG,IAAI;IAItC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAqCnE,yBAAyB,IAAI,uBAAuB;IAIpD,aAAa,IAAI,WAAW;IAInC;;;;;;OAMG;IACU,gBAAgB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAarD,kBAAkB,IAAI,MAAM;IAM5B,QAAQ,IAAI,KAAK,GAAG,SAAS;IAI7B,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIlD;;;;;OAKG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAIzC,UAAU,IAAI,OAAO;IAWrB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAWrC,kBAAkB,IAAI,WAAW,CAAC,MAAM,CAAC;IAYzC,gBAAgB,IAAI,MAAM,GAAG,SAAS;YAI/B,qBAAqB;IAiBnC;;;OAGG;IACH,OAAO,CAAC,aAAa;IAsBrB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,kBAAkB;CAI3B"}
|