You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/azcmagent-check.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,13 @@
1
1
---
2
2
title: azcmagent check CLI reference
3
3
description: Syntax for the azcmagent check command line tool
4
-
author: rpsqrd
5
4
ms.topic: reference
6
-
ms.author: ryanpu
7
5
ms.date: 04/20/2023
8
6
---
9
7
10
8
# azcmagent check
11
9
12
-
Run a series of network connectivity checks to see if the agent can successfully communicate with required network endpoints. The command will output a table showing connectivity test results for each required endpoint, including whether the agent used a private endpoint and/or proxy server.
10
+
Run a series of network connectivity checks to see if the agent can successfully communicate with required network endpoints. The command outputs a table showing connectivity test results for each required endpoint, including whether the agent used a private endpoint and/or proxy server.
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/azcmagent-config.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
---
2
2
title: azcmagent config CLI reference
3
3
description: Syntax for the azcmagent config command line tool
4
-
author: rpsqrd
5
4
ms.topic: reference
6
-
ms.author: ryanpu
7
5
ms.date: 04/20/2023
8
6
---
9
7
@@ -67,7 +65,7 @@ azcmagent config get config.mode
67
65
68
66
## azcmagent config info
69
67
70
-
Describes available configuration properties and supported values. When run without specifying a specific property, the command will describe all available properties their supported values.
68
+
Describes available configuration properties and supported values. When run without specifying a specific property, the command describes all available properties their supported values.
71
69
72
70
### Usage
73
71
@@ -143,10 +141,10 @@ azcmagent config set extensions.allowlist "Microsoft.Azure.Monitor/AzureMonitorW
143
141
144
142
`-a`, `--add`
145
143
146
-
Append the value to the list of existing values. If not specified, the default behavior is to replace the list of existing values. This flag is only supported for configuration properties that support more than one value. Cannot be used with the `--remove` flag.
144
+
Append the value to the list of existing values. If not specified, the default behavior is to replace the list of existing values. This flag is only supported for configuration properties that support more than one value. Can't be used with the `--remove` flag.
147
145
148
146
`-r`, `--remove`
149
147
150
-
Remove the specified value from the list, retaining all other values. If not specified, the default behavior is to replace the list of existing values. This flag is only supported for configuration properties that support more than one value. Cannot be used in conjunction with the `--add` flag.
148
+
Remove the specified value from the list, retaining all other values. If not specified, the default behavior is to replace the list of existing values. This flag is only supported for configuration properties that support more than one value. Can't be used in conjunction with the `--add` flag.
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/azcmagent-connect.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,13 @@
1
1
---
2
2
title: azcmagent connect CLI reference
3
3
description: Syntax for the azcmagent connect command line tool
4
-
author: rpsqrd
5
4
ms.topic: reference
6
-
ms.author: ryanpu
7
5
ms.date: 04/20/2023
8
6
---
9
7
10
8
# azcmagent connect
11
9
12
-
Connects the server to Azure Arc by creating a metadata representation of the server in Azure and associating the Azure connected machine agent with it. The command requires information about the tenant, subscription, and resource group where you want to represent the server in Azure and valid credentials with permissions to create Azure Arc-enabled servers (Microsoft.HybridCompute/machines) resources in that location.
10
+
Connects the server to Azure Arc by creating a metadata representation of the server in Azure and associating the Azure connected machine agent with it. The command requires information about the tenant, subscription, and resource group where you want to represent the server in Azure and valid credentials with permissions to create Azure Arc-enabled server resources in that location.
@@ -42,15 +41,15 @@ There are 4 ways to provide authentication credentials to the Azure connected ma
42
41
43
42
### Interactive browser login (Windows-only)
44
43
45
-
This option is the default on Windows operating systems with a desktop experience. It will open the login page in your default web browser. This option may be required if your organization has configured conditional access policies that require you to log in from trusted machines.
44
+
This option is the default on Windows operating systems with a desktop experience. It login page opens in your default web browser. This option may be required if your organization has configured conditional access policies that require you to log in from trusted machines.
46
45
47
46
No flag is required to use the interactive browser login.
48
47
49
48
### Device code login
50
49
51
-
This option generates a code that you can use to log in on a web browser on another device. This is the default option on Windows Server core editions and all Linux distributions. When you execute the connect command, you will have 5 minutes to open the specified login URL on an internet-connected device and complete the login flow.
50
+
This option generates a code that you can use to log in on a web browser on another device. This is the default option on Windows Server core editions and all Linux distributions. When you execute the connect command, you have 5 minutes to open the specified login URL on an internet-connected device and complete the login flow.
52
51
53
-
To authenticate with a device code, use the `--use-device-code` flag. If the account you're logging in with and the subscription where you're registering the server are not in the same tenant, you must also provide the tenant ID for the subscription with `--tenant-id [tenant]`.
52
+
To authenticate with a device code, use the `--use-device-code` flag. If the account you're logging in with and the subscription where you're registering the server aren't in the same tenant, you must also provide the tenant ID for the subscription with `--tenant-id [tenant]`.
54
53
55
54
### Service principal
56
55
@@ -62,13 +61,13 @@ To authenticate with a service principal, provide the service principal's applic
62
61
63
62
Access tokens can also be used for non-interactive authentication, but are short-lived and typically used by automation solutions onboarding several servers over a short period of time. You can get an access token with [Get-AzAccessToken](/powershell/module/az.accounts/get-azaccesstoken) or any other Azure Active Directory client.
64
63
65
-
To authenticate with an access token, use the `--access-token [token]` flag. If the account you're logging in with and the subscription where you're registering the server are not in the same tenant, you must also provide the tenant ID for the subscription with `--tenant-id [tenant]`.
64
+
To authenticate with an access token, use the `--access-token [token]` flag. If the account you're logging in with and the subscription where you're registering the server aren't in the same tenant, you must also provide the tenant ID for the subscription with `--tenant-id [tenant]`.
66
65
67
66
## Flags
68
67
69
68
`--access-token`
70
69
71
-
Specifies the Azure Active Directory access token used to create the Azure Arc-enabled server resource in Azure. See [authentication options](#authentication-options) for more information.
70
+
Specifies the Azure Active Directory access token used to create the Azure Arc-enabled server resource in Azure. For more information, see [authentication options](#authentication-options).
72
71
73
72
`--cloud`
74
73
@@ -82,11 +81,11 @@ Supported values:
82
81
83
82
`--correlation-id`
84
83
85
-
Identifies the mechanism being used to connect the server to Azure Arc. For example, the GUID may indicate the agent was installed by a script generated in the Azure Portal or executed as part of an Azure Arc Jumpstart scenario. This flag is optional and only used for telemetry purposes.
84
+
Identifies the mechanism being used to connect the server to Azure Arc. For example, scripts generated in the Azure Portal include a GUID that helps Microsoft track usage of that experience. This flag is optional and only used for telemetry purposes to improve your experience.
86
85
87
86
`--ignore-network-check`
88
87
89
-
Instructs the agent to continue onboarding even if the network check for required endpoints fails. You should only use this option if you're sure that the network check results are incorrect. In most cases, a failed network check indicates that the Arc agent will not function correctly on the server.
88
+
Instructs the agent to continue onboarding even if the network check for required endpoints fails. You should only use this option if you're sure that the network check results are incorrect. In most cases, a failed network check indicates that the Arc agent won't function correctly on the server.
90
89
91
90
`-l`, `--location`
92
91
@@ -96,7 +95,7 @@ Sample value: westeurope
96
95
97
96
`--private-link-scope`
98
97
99
-
Specifies the resource ID of the Azure Arc private link scope to associate with the server. This flag is required if you are using private endpoints to connect the server to Azure.
98
+
Specifies the resource ID of the Azure Arc private link scope to associate with the server. This flag is required if you're using private endpoints to connect the server to Azure.
100
99
101
100
`-g`, `--resource-group`
102
101
@@ -111,19 +110,19 @@ Name for the Azure Arc-enabled server resource. By default, the resource name is
111
110
* The AWS instance ID, if the server is on AWS
112
111
* The hostname for all other machines
113
112
114
-
You can override the default name with a name of your own choosing to avoid naming conflicts. Once chosen, the name of the Azure resource cannot be changed without disconnecting and re-connecting the agent.
113
+
You can override the default name with a name of your own choosing to avoid naming conflicts. Once chosen, the name of the Azure resource can't be changed without disconnecting and re-connecting the agent.
115
114
116
115
If you want to force AWS servers to use the hostname instead of the instance ID, pass in `$(hostname)` to have the shell evaluate the current hostname and pass that in as the new resource name.
117
116
118
117
Sample value: FileServer01
119
118
120
119
`-i`, `--service-principal-id`
121
120
122
-
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. See [authentication options](#authentication-options) for more information.
121
+
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).
123
122
124
123
`-p`, `--service-principal-secret`
125
124
126
-
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. See [authentication options](#authentication-options) for more information.
125
+
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).
The tenant ID for the subscription where you want to create the Azure Arc-enabled server resource. This is required when authenticating with a service principal. For all other authentication methods, the home tenant of the account used to authenticate with Azure is used for the resource as well. If the tenant for the account and subscription are different (guest accounts, Lighthouse), you must specify the tenant ID to clarify the tenant where the subscription is located.
141
+
The tenant ID for the subscription where you want to create the Azure Arc-enabled server resource. This flag is required when authenticating with a service principal. For all other authentication methods, the home tenant of the account used to authenticate with Azure is used for the resource as well. If the tenants for the account and subscription are different (guest accounts, Lighthouse), you must specify the tenant ID to clarify the tenant where the subscription is located.
143
142
144
143
`--use-device-code`
145
144
146
-
Generate an Azure Active Directory device login code that can be entered in a web browser on another computer to authenticate the agent with Azure. See [authentication options](#authentication-options) for more information.
145
+
Generate an Azure Active Directory device login code that can be entered in a web browser on another computer to authenticate the agent with Azure. For more information, see [authentication options](#authentication-options).
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/azcmagent-disconnect.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
---
2
2
title: azcmagent disconnect CLI reference
3
3
description: Syntax for the azcmagent disconnect command line tool
4
-
author: rpsqrd
5
4
ms.topic: reference
6
-
ms.author: ryanpu
7
5
ms.date: 04/20/2023
8
6
---
9
7
@@ -45,13 +43,13 @@ There are 4 ways to provide authentication credentials to the Azure connected ma
45
43
46
44
### Interactive browser login (Windows-only)
47
45
48
-
This option is the default on Windows operating systems with a desktop experience. It will open the login page in your default web browser. This option may be required if your organization has configured conditional access policies that require you to log in from trusted machines.
46
+
This option is the default on Windows operating systems with a desktop experience. The login page opens in your default web browser. This option may be required if your organization has configured conditional access policies that require you to log in from trusted machines.
49
47
50
48
No flag is required to use the interactive browser login.
51
49
52
50
### Device code login
53
51
54
-
This option generates a code that you can use to log in on a web browser on another device. This is the default option on Windows Server core editions and all Linux distributions. When you execute the connect command, you will have 5 minutes to open the specified login URL on an internet-connected device and complete the login flow.
52
+
This option generates a code that you can use to log in on a web browser on another device. This is the default option on Windows Server core editions and all Linux distributions. When you execute the connect command, you have 5 minutes to open the specified login URL on an internet-connected device and complete the login flow.
55
53
56
54
To authenticate with a device code, use the `--use-device-code` flag.
57
55
@@ -71,22 +69,22 @@ To authenticate with an access token, use the `--access-token [token]` flag.
71
69
72
70
`--access-token`
73
71
74
-
Specifies the Azure Active Directory access token used to create the Azure Arc-enabled server resource in Azure. See [authentication options](#authentication-options) for more information.
72
+
Specifies the Azure Active Directory access token used to create the Azure Arc-enabled server resource in Azure. For more information, see [authentication options](#authentication-options).
75
73
76
74
`-f`, `--force-local-only`
77
75
78
76
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.
79
77
80
78
`-i`, `--service-principal-id`
81
79
82
-
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. See [authentication options](#authentication-options) for more information.
80
+
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).
83
81
84
82
`-p`, `--service-principal-secret`
85
83
86
-
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. See [authentication options](#authentication-options) for more information.
84
+
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).
87
85
88
86
`--use-device-code`
89
87
90
-
Generate an Azure Active Directory device login code that can be entered in a web browser on another computer to authenticate the agent with Azure. See [authentication options](#authentication-options) for more information.
88
+
Generate an Azure Active Directory device login code that can be entered in a web browser on another computer to authenticate the agent with Azure. For more information, see [authentication options](#authentication-options).
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/azcmagent-genkey.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,13 @@
1
1
---
2
2
title: azcmagent genkey CLI reference
3
3
description: Syntax for the azcmagent genkey command line tool
4
-
author: rpsqrd
5
4
ms.topic: reference
6
-
ms.author: ryanpu
7
5
ms.date: 04/20/2023
8
6
---
9
7
10
8
# azcmagent genkey
11
9
12
-
Generates a private-public key pair that can be used to onboard a machine asynchronously. This command is reserved for use by Azure Arc virtual machine offerings and is not intended to be directly called by users.
10
+
Generates a private-public key pair that can be used to onboard a machine asynchronously. This command is used when connecting a server to an Azure Arc-enabled virtual machine offering (VMware vSphere, Azure Stack HCI, or System Center VMM). It is not intended for use by end users.
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/azcmagent-logs.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
---
2
2
title: azcmagent logs CLI reference
3
3
description: Syntax for the azcmagent logs command line tool
4
-
author: rpsqrd
5
4
ms.topic: reference
6
-
ms.author: ryanpu
7
5
ms.date: 04/20/2023
8
6
---
9
7
@@ -39,7 +37,7 @@ Collect all log files on the system instead of just the most recent. Useful when
39
37
40
38
`-o`, `--output`
41
39
42
-
Specifies the path and name for the ZIP file. If this flag is not specified, the ZIP will be saved to the console's current directory with the name "azcmagent-_TIMESTAMP_-_COMPUTERNAME_.zip"
40
+
Specifies the path and name for the ZIP file. If this flag is not specified, the ZIP is saved to the console's current directory with the name "azcmagent-_TIMESTAMP_-_COMPUTERNAME_.zip"
0 commit comments