Skip to content

Commit 5bd7843

Browse files
authored
Merge pull request #102184 from itechedit/quickstart-onboard-portal
edit pass: quickstart-onboard-portal
2 parents 007d46a + d49adbc commit 5bd7843

File tree

1 file changed

+66
-61
lines changed

1 file changed

+66
-61
lines changed
Lines changed: 66 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Connect hybrid machines to Azure from the Azure portal
3-
description: In this article, you learn how to install the agent and connect machines to Azure using Azure Arc for servers (preview) from the Azure portal.
3+
description: In this article, you learn how to install the agent and connect machines to Azure by using Azure Arc for servers (preview) from the Azure portal.
44
services: azure-arc
55
ms.service: azure-arc
66
ms.subservice: azure-arc-servers
@@ -13,49 +13,51 @@ ms.topic: quickstart
1313

1414
# Connect hybrid machines to Azure from the Azure portal
1515

16-
You can enable Azure Arc for servers (preview) for one or a small number of Windows or Linux machines in your environment by performing a set of steps manually, or using an automated method by running a template script that we provide. This script automates the download and installation of both agents.
16+
You can enable Azure Arc for servers (preview) for one or a small number of Windows or Linux machines in your environment by performing a set of steps manually. Or you can use an automated method by running a template script that we provide. This script automates the download and installation of both agents.
1717

18-
This installation method requires that you have administrative rights on the machine to install and configure the agent. On Linux, using the root account and on Windows, you are member of the Local Administrators group.
18+
This method requires that you have administrator permissions on the machine to install and configure the agent. On Linux, by using the root account, and on Windows, you are member of the Local Administrators group.
1919

2020
Before you get started, be sure to review the [prerequisites](overview.md#prerequisites) and verify that your subscription and resources meet the requirements.
2121

2222
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2323

24-
## Generate install script from the Azure portal
24+
## Generate the installation script from the Azure portal
2525

26-
The script to automate the download, installation, and establishing the connection with Azure Arc is available from the Azure portal. The following steps describe how to complete this process.
26+
The script to automate the download and installation, and to establish the connection with Azure Arc, is available from the Azure portal. To complete the process, do the following:
2727

28-
1. From your browser, launch [https://aka.ms/hybridmachineportal](https://aka.ms/hybridmachineportal).
28+
1. From your browser, go to the [Azure portal](https://aka.ms/hybridmachineportal).
2929

30-
2. On the **Machines - Azure Arc** page, either select **+Add** in the upper left-hand corner, or select the **Create machine - Azure Arc** option from the bottom of the middle pane.
30+
1. On the **Machines - Azure Arc** page, select either **Add**, at the upper left, or the **Create machine - Azure Arc** option at the bottom of the middle pane.
3131

32-
3. On the **Select a method** page, select from the **Add machines using interactive script** tile **Generate script**.
32+
1. On the **Select a method** page, select the **Add machines using interactive script** tile, and then select **Generate script**.
3333

34-
4. On the **Generate script** page, select the subscription and resource group where you want the machine to be managed within Azure. Select an Azure location where machine metadata will be stored.
34+
1. On the **Generate script** page, select the subscription and resource group where you want the machine to be managed within Azure. Select an Azure location where the machine metadata will be stored.
3535

3636
>[!NOTE]
37-
>Azure Arc for servers (preview), only supports the following regions:
37+
>Azure Arc for servers (preview) supports only the following regions:
3838
>- WestUS2
3939
>- WestEurope
4040
>- WestAsia
4141
>
4242
43-
5. On the **Generate script** page, under the **Operating system** drop-down list, select the appropriate operating system the script will be running on.
43+
1. On the **Generate script** page, in the **Operating system** drop-down list, select the operating system that the script will be running on.
4444

45-
6. If the machine is communicating through a proxy server in order to connect to the Internet, select the option **Next: Proxy Server>**. On the **Proxy server** tab, specify the proxy server IP address or name and port number that the machine will use to communicate with the proxy server. Enter the value following the format `http://<proxyURL>:<proxyport>`. Once completed, select **Review + generate**. Otherwise, select **Review + generate** to complete the steps.
45+
1. If the machine is communicating through a proxy server to connect to the internet, select **Next: Proxy Server**.
46+
1. On the **Proxy server** tab, specify the proxy server IP address or the name and port number that the machine will use to communicate with the proxy server. Enter the value in the format `http://<proxyURL>:<proxyport>`.
47+
1. Select **Review + generate**.
4648

47-
7. On the **Review + generate** tab, review the summary information, and then select **Download**. Otherwise if you need to make changes, you can select **Previous**.
49+
1. On the **Review + generate** tab, review the summary information, and then select **Download**. If you still need to make changes, select **Previous**.
4850

4951
## Install and validate the agent on Windows
5052

5153
### Install manually
54+
You can install the Connected Machine agent manually by running the Windows Installer package *AzureConnectedMachineAgent.msi*.
5255

53-
You can install the Connected Machine agent manually by running the Windows Installer installation package `AzureConnectedMachineAgent.msi` after downloading it and copying it to a folder on the target server, or from a shared network folder. If you run the Installer package without any options, it starts a setup wizard that you can follow to install the agent interactively.
56+
> [!NOTE]
57+
> * To install or uninstall the agent, you must have *Administrator* permissions.
58+
> * You must first download and copy the Installer package to a folder on the target server, or from a shared network folder. If you run the Installer package without any options, it starts a setup wizard that you can follow to install the agent interactively.
5459
55-
>[!NOTE]
56-
>*Administrator* privileges are required to install or uninstall the agent.
57-
58-
If the machine needs to communicate through a proxy server to the service, after you install the agent you need to run a command described in a section below, to set the proxy server system environment variable `https_proxy`.
60+
If the machine needs to communicate through a proxy server to the service, after you install the agent you need to run a command that's described later in the article. This sets the proxy server system environment variable `https_proxy`.
5961

6062
The following table highlights the parameters that are supported by setup for the agent from the command line.
6163

@@ -68,23 +70,23 @@ For example, to run the installation program with the `/?` parameter, enter `msi
6870

6971
Files for the Connected Machine agent are installed in *C:\Program Files\AzureConnectedMachineAgent* by default. If the agent fails to start after setup is finished, check the logs for detailed error information. The log directory is *%Programfiles%\AzureConnectedMachineAgentAgent\logs*.
7072

71-
### Install using scripted method
73+
### Install with the scripted method
7274

73-
1. Log onto the server.
75+
1. Log in to the server.
7476

75-
2. Open an elevated PowerShell command prompt.
77+
1. Open an elevated PowerShell command prompt.
7678

77-
3. Change to the folder or share you copied the script to and execute it on the server by running the command `./OnboardingScript.ps1`.
79+
1. Change to the folder or share that you copied the script to, and execute it on the server by running the `./OnboardingScript.ps1` script.
7880

79-
### Configure agent proxy setting
81+
### Configure the agent proxy setting
8082

81-
Run the following command to set the proxy server environment variable.
83+
To set the proxy server environment variable, run the following command:
8284

8385
```powershell
84-
# If a proxy server is needed, execute these commands with proxy URL and port
86+
# If a proxy server is needed, execute these commands with the proxy URL and port.
8587
[Environment]::SetEnvironmentVariable("https_proxy", "http://{proxy-url}:{proxy-port}", "Machine")
8688
$env:https_proxy = [System.Environment]::GetEnvironmentVariable("https_proxy","Machine")
87-
# The agent service needs to be restarted after the proxy environment variable is set in order for the changes to take effect.
89+
# For the changes to take effect, the agent service needs to be restarted after the proxy environment variable is set.
8890
Restart-Service -Name himds
8991
```
9092

@@ -100,18 +102,19 @@ After installing the agent, you need to configure the agent to communicate with
100102

101103
## Install and validate the agent on Linux
102104

103-
The Connected Machine agent for Linux is provided in the preferred package format for the distribution (.RPM or .DEB) hosted on Microsoft's [package repository](https://packages.microsoft.com/). A shell script bundle `Install_linux_azcmagent.sh` located at [https://aka.ms/azcmagent](https://aka.ms/azcmagent) performs the following actions:
105+
The Connected Machine agent for Linux is provided in the preferred package format for the distribution (.RPM or .DEB) that's hosted in the Microsoft [package repository](https://packages.microsoft.com/). The [shell script bundle `Install_linux_azcmagent.sh`](https://aka.ms/azcmagent) performs the following actions:
104106

105107
- Configures the host machine to download the agent package from packages.microsoft.com.
106108
- Installs the Hybrid Resource Provider package.
107-
- Optionally, configure the agent with your proxy information by including the `--proxy "{proxy-url}:{proxy-port}"` parameter.
108109

109-
The script also contains logic to identify supported and unsupported distributions, as well as verifying required permissions to perform the installation.
110+
Optionally, you can configure the agent with your proxy information by including the `--proxy "{proxy-url}:{proxy-port}"` parameter.
110111

111-
The example below downloads the agent and installs it, without performing any of the conditional checks.
112+
The script also contains logic to identify the supported and unsupported distributions, and it verifies the permissions that are required to perform the installation.
113+
114+
The following example downloads the agent and installs it:
112115

113116
```bash
114-
# Download the installation package
117+
# Download the installation package.
115118
wget https://aka.ms/azcmagent -O ~/Install_linux_azcmagent.sh
116119

117120
# Install the connected machine agent.
@@ -121,62 +124,64 @@ bash ~/Install_linux_azcmagent.sh
121124
To download and install the agent, including the `--proxy` parameter for configuring the agent to communicate through your proxy server, run the following commands:
122125

123126
```bash
124-
# Download the installation package
127+
# Download the installation package.
125128
wget https://aka.ms/azcmagent -O ~/Install_linux_azcmagent.sh
126129

127130
# Install the connected machine agent.
128131
bash ~/Install_linux_azcmagent.sh --proxy "{proxy-url}:{proxy-port}"
129132
```
130133

131-
### Configure agent communication
134+
### Configure the agent communication
132135

133-
After installing the agent, you need to configure the agent to communicate with the Azure Arc service by running the following command:
136+
After you install the agent, configure it to communicate with the Azure Arc service by running the following command:
134137

135138
`/opt/azcmagent/bin/azcmagent.exe" connect --resource-group "<resourceGroupName>" --tenant-id "<tenantID>" --location "<regionName>" --subscription-id "<subscriptionID>"`
136139

137-
## Verify connection with Azure Arc
140+
## Verify the connection with Azure Arc
138141

139-
After performing the steps to install the agent and configure it to connect to Azure Arc for servers (preview), go to the Azure portal to verify that the server has been successfully connected. You can view your machines in the Azure portal by visiting [https://aka.ms/hybridmachineportal](https://aka.ms/hybridmachineportal).
142+
After you install the agent and configure it to connect to Azure Arc for servers (preview), go to the Azure portal to verify that the server has been successfully connected. View your machines in the [Azure portal](https://aka.ms/hybridmachineportal).
140143

141-
![Successful Onboarding](./media/quickstart-onboard/arc-for-servers-successful-onboard.png)
144+
![A successful server connection](./media/quickstart-onboard/arc-for-servers-successful-onboard.png)
142145

143146
## Clean up
144147

145-
To disconnect a machine from Azure Arc for servers (preview), you need to perform the following steps.
146-
147-
1. Open Azure Arc for servers (preview) by visiting [https://aka.ms/hybridmachineportal](https://aka.ms/hybridmachineportal).
148+
To disconnect a machine from Azure Arc for servers (preview), do the following:
148149

149-
2. Select the machine in the list, click the ellipse (`...`) and select **Delete**.
150+
1. Open Azure Arc for servers (preview) by going to the [Azure portal](https://aka.ms/hybridmachineportal).
150151

151-
3. To uninstall the Windows agent from the machine, perform the following:
152+
1. Select the machine in the list, select the ellipsis (**...**), and then select **Delete**.
152153

153-
1. Sign on to the computer with an account that has administrative rights.
154+
1. To uninstall the Windows agent from the machine, do the following:
154155

155-
2. In **Control Panel**, select **Programs and Features**.
156+
a. Sign in to the computer with an account that has administrator permissions.
157+
b. In **Control Panel**, select **Programs and Features**.
158+
c. In **Programs and Features**, select **Azure Connected Machine Agent**, select **Uninstall**, and then select **Yes**.
156159

157-
3. In **Programs and Features**, select **Azure Connected Machine Agent**, select **Uninstall**, and then select **Yes**.
158-
159-
>[!NOTE]
160-
>The agent Setup Wizard can also be run by double-clicking **AzureConnectedMachineAgent.msi** installer package.
160+
>[!NOTE]
161+
> You can also run the agent setup wizard by double-clicking the **AzureConnectedMachineAgent.msi** installer package.
161162
162-
If you would like to script the uninstall, you can use the following example, which retrieves the product code and uninstalls the agent using the Msiexec.exe command line - `msiexec /x {Product Code}`. Open the Registry Editor and look under the registry key `HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall` and find the product code GUID. You can then uninstall the agent using Msiexec.
163+
If you want to script the uninstallation, you can use the following example, which retrieves the product code and uninstalls the agent by using the Msiexec.exe command line - `msiexec /x {Product Code}`. To do so:
164+
165+
a. Open the Registry Editor.
166+
b. Under registry key `HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall`, look for and copy the product code GUID.
167+
c. You can then uninstall the agent by using Msiexec.
163168

164-
The example below demonstrates uninstalling the agent.
169+
The following example demonstrates how to uninstall the agent:
165170

166-
```powershell
167-
Get-ChildItem -Path HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall | `
168-
Get-ItemProperty | `
169-
Where-Object {$_.DisplayName -eq "Azure Connected Machine Agent"} | `
170-
ForEach-Object {MsiExec.exe /x "$($_.PsChildName)" /qn}
171-
```
171+
```powershell
172+
Get-ChildItem -Path HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall | `
173+
Get-ItemProperty | `
174+
Where-Object {$_.DisplayName -eq "Azure Connected Machine Agent"} | `
175+
ForEach-Object {MsiExec.exe /x "$($_.PsChildName)" /qn}
176+
```
172177
173-
4. To uninstall the Linux agent, execute the following command to uninstall the agent.
178+
1. To uninstall the Linux agent, run the following command:
174179
175-
```bash
176-
sudo apt purge hybridagent
177-
```
180+
```bash
181+
sudo apt purge hybridagent
182+
```
178183
179184
## Next steps
180185
181186
> [!div class="nextstepaction"]
182-
> [Assign a Policy to Connected Machines](../../governance/policy/assign-policy-portal.md)
187+
> [Assign a policy to connected machines](../../governance/policy/assign-policy-portal.md)

0 commit comments

Comments
 (0)