Skip to content

Commit 0dc33f1

Browse files
author
Ryan Willis
committed
Acrolinx improvements
1 parent 919d62e commit 0dc33f1

File tree

2 files changed

+23
-15
lines changed

2 files changed

+23
-15
lines changed

articles/azure-arc/servers/azcmagent-connect.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ azcmagent connect --subscription-id "Production" --resource-group "HybridServers
4141

4242
## Authentication options
4343

44-
There are 4 ways to provide authentication credentials to the Azure connected machine agent. Choose one authentication option and replace the `[authentication]` section in the usage syntax with the recommended flags.
44+
There are four ways to provide authentication credentials to the Azure connected machine agent. Choose one authentication option and replace the `[authentication]` section in the usage syntax with the recommended flags.
4545

4646
### Interactive browser login (Windows-only)
4747

48-
This option is the default on Windows operating systems with a desktop experience. It login page opens in your default web browser. This option might be required if your organization has configured conditional access policies that require you to log in from trusted machines.
48+
This option is the default on Windows operating systems with a desktop experience. It login page opens in your default web browser. This option might be required if your organization configured conditional access policies that require you to log in from trusted machines.
4949

5050
No flag is required to use the interactive browser login.
5151

@@ -57,15 +57,15 @@ To authenticate with a device code, use the `--use-device-code` flag. If the acc
5757

5858
### Service principal with secret
5959

60-
Service principals allow you to authenticate non-interactively and are often used for at-scale deployments where the same script is run across multiple servers. It's recommended that you provide service principal information via a configuration file (see `--config`) to avoid exposing the secret in any console logs. The service principal should also be dedicated for Arc onboarding and have as few permissions as possible, to limit the impact of a stolen credential.
60+
Service principals allow you to authenticate non-interactively and are often used for at-scale deployments where the same script is run across multiple servers. Microsoft recommends providing service principal information via a configuration file (see `--config`) to avoid exposing the secret in any console logs. The service principal should also be dedicated for Arc onboarding and have as few permissions as possible, to limit the impact of a stolen credential.
6161

6262
To authenticate with a service principal using a secret, provide the service principal's application ID, secret, and tenant ID: `--service-principal-id [appid] --service-principal-secret [secret] --tenant-id [tenantid]`
6363

6464
### Service principal with certificate
6565

66-
Certificate-based authentication is a more secure way to authenticate using service principals. The agent accepts both PCKS #12 (PFX) files and ASCII-encoded files (such as PEM) that contain both the private and public keys. The certificate must be available on the local disk and the user running the `azcmagent` command must have read access to the file. Password-protected PFX files are not supported.
66+
Certificate-based authentication is a more secure way to authenticate using service principals. The agent accepts both PCKS #12 (.PFX) files and ASCII-encoded files (such as .PEM) that contain both the private and public keys. The certificate must be available on the local disk and the user running the `azcmagent` command needs read access to the file. Password-protected PFX files are not supported.
6767

68-
To authenticate with a service principal using a certificate, provide the service principal's application ID, tenant ID and path to the certificate file: `--service-principal-id [appId] --service-principal-cert [pathToPEMorPFXfile] --tenant-id [tenantid]`
68+
To authenticate with a service principal using a certificate, provide the service principal's application ID, tenant ID, and path to the certificate file: `--service-principal-id [appId] --service-principal-cert [pathToPEMorPFXfile] --tenant-id [tenantid]`
6969

7070
For more information, see [create a service principal for RBAC with certificate-based authentication](/cli/azure/azure-cli-sp-tutorial-3).
7171

@@ -136,11 +136,15 @@ Sample value: FileServer01
136136

137137
`-i`, `--service-principal-id`
138138

139-
Specifies the application ID of the service principal used to create the Azure Arc-enabled server resource in Azure. Must be used with the `--service-principal-secret` and `--tenant-id` flags. For more information, see [authentication options](#authentication-options).
139+
Specifies the application ID of the service principal used to create the Azure Arc-enabled server resource in Azure. Must be used with the `--tenant-id` and either the `--service-principal-secret` or `--service-principal-cert` flags. For more information, see [authentication options](#authentication-options).
140+
141+
`--service-principal-cert`
142+
143+
Specifies the path to a service principal certificate file. Must be used with the `--service-principal-id` and `--tenant-id` flags. The certificate must include a private key and can be in a PKCS #12 (.PFX) or ASCII-encoded text (.PEM, .CRT) format. Password-protected PFX files are not supported. For more information, see [authentication options](#authentication-options).
140144

141145
`-p`, `--service-principal-secret`
142146

143-
Specifies the service principal secret. Must be used with the `--service-principal-id` and `--tenant-id` flags. To avoid exposing the secret in console logs, it's recommended to pass in the service principal secret in a configuration file. For more information, see [authentication options](#authentication-options).
147+
Specifies the service principal secret. Must be used with the `--service-principal-id` and `--tenant-id` flags. To avoid exposing the secret in console logs, Microsoft recommended providing the service principal secret in a configuration file. For more information, see [authentication options](#authentication-options).
144148

145149
`-s`, `--subscription-id`
146150

articles/azure-arc/servers/azcmagent-disconnect.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ azcmagent disconnect --force-local-only
3737

3838
## Authentication options
3939

40-
There are 4 ways to provide authentication credentials to the Azure connected machine agent. Choose one authentication option and replace the `[authentication]` section in the usage syntax with the recommended flags.
40+
There are four ways to provide authentication credentials to the Azure connected machine agent. Choose one authentication option and replace the `[authentication]` section in the usage syntax with the recommended flags.
4141

4242
> [!NOTE]
4343
> The account used to disconnect a server must be from the same tenant as the subscription where the server is registered.
4444
4545
### Interactive browser login (Windows-only)
4646

47-
This option is the default on Windows operating systems with a desktop experience. The login page opens in your default web browser. This option might be required if your organization has configured conditional access policies that require you to log in from trusted machines.
47+
This option is the default on Windows operating systems with a desktop experience. The login page opens in your default web browser. This option might be required if your organization configured conditional access policies that require you to log in from trusted machines.
4848

4949
No flag is required to use the interactive browser login.
5050

@@ -56,15 +56,15 @@ To authenticate with a device code, use the `--use-device-code` flag.
5656

5757
### Service principal with secret
5858

59-
Service principals allow you to authenticate non-interactively and are often used for at-scale deployments where the same script is run across multiple servers. It's recommended that you provide service principal information via a configuration file (see `--config`) to avoid exposing the secret in any console logs. The service principal should also be dedicated for Arc onboarding and have as few permissions as possible, to limit the impact of a stolen credential.
59+
Service principals allow you to authenticate non-interactively and are often used for at-scale operations where the same script is run across multiple servers. It's recommended that you provide service principal information via a configuration file (see `--config`) to avoid exposing the secret in any console logs. The service principal should also be dedicated for Arc onboarding and have as few permissions as possible, to limit the impact of a stolen credential.
6060

6161
To authenticate with a service principal using a secret, provide the service principal's application ID, secret, and tenant ID: `--service-principal-id [appid] --service-principal-secret [secret] --tenant-id [tenantid]`
6262

6363
### Service principal with certificate
6464

65-
Certificate-based authentication is a more secure way to authenticate using service principals. The agent accepts both PCKS #12 (PFX) files and ASCII-encoded files (such as PEM) that contain both the private and public keys. The certificate must be available on the local disk and the user running the `azcmagent` command must have read access to the file. Password-protected PFX files are not supported.
65+
Certificate-based authentication is a more secure way to authenticate using service principals. The agent accepts both PCKS #12 (.PFX) files and ASCII-encoded files (such as .PEM) that contain both the private and public keys. The certificate must be available on the local disk and the user running the `azcmagent` command needs read access to the file. Password-protected PFX files are not supported.
6666

67-
To authenticate with a service principal using a certificate, provide the service principal's application ID, tenant ID and path to the certificate file: `--service-principal-id [appId] --service-principal-cert [pathToPEMorPFXfile] --tenant-id [tenantid]`
67+
To authenticate with a service principal using a certificate, provide the service principal's application ID, tenant ID, and path to the certificate file: `--service-principal-id [appId] --service-principal-cert [pathToPEMorPFXfile] --tenant-id [tenantid]`
6868

6969
For more information, see [create a service principal for RBAC with certificate-based authentication](/cli/azure/azure-cli-sp-tutorial-3).
7070

@@ -82,15 +82,19 @@ Specifies the Microsoft Entra access token used to create the Azure Arc-enabled
8282

8383
`-f`, `--force-local-only`
8484

85-
Disconnects the server without deleting the resource in Azure. Primarily used if the Azure resource has already been deleted and the local agent configuration needs to be cleaned up.
85+
Disconnects the server without deleting the resource in Azure. Primarily used if the Azure resource was deleted and the local agent configuration needs to be cleaned up.
8686

8787
`-i`, `--service-principal-id`
8888

89-
Specifies the application ID of the service principal used to create the Azure Arc-enabled server resource in Azure. Must be used with the `--service-principal-secret` and `--tenant-id` flags. For more information, see [authentication options](#authentication-options).
89+
Specifies the application ID of the service principal used to create the Azure Arc-enabled server resource in Azure. Must be used with the `--tenant-id` and either the `--service-principal-secret` or `--service-principal-cert` flags. For more information, see [authentication options](#authentication-options).
90+
91+
`--service-principal-cert`
92+
93+
Specifies the path to a service principal certificate file. Must be used with the `--service-principal-id` and `--tenant-id` flags. The certificate must include a private key and can be in a PKCS #12 (.PFX) or ASCII-encoded text (.PEM, .CRT) format. Password-protected PFX files are not supported. For more information, see [authentication options](#authentication-options).
9094

9195
`-p`, `--service-principal-secret`
9296

93-
Specifies the service principal secret. Must be used with the `--service-principal-id` and `--tenant-id` flags. To avoid exposing the secret in console logs, it's recommended to pass in the service principal secret in a configuration file. For more information, see [authentication options](#authentication-options).
97+
Specifies the service principal secret. Must be used with the `--service-principal-id` and `--tenant-id` flags. To avoid exposing the secret in console logs, Microsoft recommendeds providing the service principal secret in a configuration file. For more information, see [authentication options](#authentication-options).
9498

9599
`--use-device-code`
96100

0 commit comments

Comments
 (0)