Skip to content

Commit 198cc11

Browse files
committed
fixing acrolinx
1 parent 1b5bb1f commit 198cc11

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

articles/sentinel/notebooks-msticpy-advanced.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For more information, see [Use Jupyter notebooks to hunt for security threats](n
2020

2121
## Prerequisites
2222

23-
This article is a continuation on from [Get started with Jupyter notebooks and MSTICPy in Microsoft Sentinel](notebook-get-started.md). We recommend that you perform the tutorial before continuing with the advanced procedures described below.
23+
This article is a continuation on from [Get started with Jupyter notebooks and MSTICPy in Microsoft Sentinel](notebook-get-started.md). We recommend that you perform the tutorial before continuing with the advanced procedures described in this article.
2424

2525
## Specify authentication parameters for Azure and Microsoft Sentinel APIs
2626

@@ -67,11 +67,11 @@ When you frequently author new notebooks, autoloading query providers can save y
6767

6868
Each provider also has the following optional values:
6969

70-
- **Auto-connect:** This option is defined as **True** by default, and MSTICPy tries to authenticate to the provider immediately after loading. MSTICPy assumes that you've configured credentials for the provider in your settings.
70+
- **Auto-connect:** This option is defined as **True** by default, and MSTICPy tries to authenticate to the provider immediately after loading. MSTICPy assumes that you configured credentials for the provider in your settings.
7171

7272
- **Alias:** When MSTICPy loads a provider, it assigns the provider to a Python variable name. By default, the variable name is **qryworkspace_name** for Microsoft Sentinel providers and **qryprovider_name** for other providers.
7373

74-
For example, if you load a query provider for the *ContosoSOC* workspace, this query provider will be created in your notebook environment with the name `qry_ContosoSOC`. Add an alias if you want to use something shorter or easier to type and remember. The provider variable name will be `qry_<alias>`, where `<alias>` is replaced by the alias name that you provided.
74+
For example, if you load a query provider for the *ContosoSOC* workspace, this query provider is created in your notebook environment with the name `qry_ContosoSOC`. Add an alias if you want to use something shorter or easier to type and remember. The provider variable name is `qry_<alias>`, where `<alias>` is replaced by the alias name that you provided.
7575

7676
Providers you load by this mechanism are also added to the MSTICPy `current_providers` attribute, which is used, for example, in the following code:
7777

@@ -108,8 +108,8 @@ The components load in this order because the Pivot component needs query and ot
108108

109109
1. In the **Autoload Components** tab, define any parameter values as needed. For example:
110110

111-
- **GeoIpLookup**. Enter the name of the GeoIP provider you want to use, either *GeoLiteLookup* or *IPStack*.
112-
- **AzureData and AzureSentinelAPI components**. Define the following values:
111+
- **GeoIpLookup**. Enter the name of the GeoIP provider you want to use, either *GeoLiteLookup* or *IPStack*.
112+
- **AzureData and AzureSentinelAPI components**. Define the following values:
113113

114114
- **auth_methods:** Override the default settings for AzureCLI, and connect using the selected methods.
115115
- **Auto-connect:** Set to false to load without connecting.
@@ -135,11 +135,11 @@ The components load in this order because the Pivot component needs query and ot
135135

136136
## Switch between Python 3.6 and 3.8 kernels
137137

138-
If you're switching between Python 3.65 and 3.8 kernels, you may find that MSTICPy and other packages don't get installed as expected.
138+
If you're switching between Python 3.65 and 3.8 kernels, you might find that MSTICPy and other packages don't get installed as expected.
139139

140-
This may happen when the `!pip install pkg` command will install correctly in the first environment, but then doesn't install correctly in the second. This creates a situation where the second environment can't import or use the package.
140+
This might happen when the `!pip install pkg` command installs correctly in the first environment, but then doesn't install correctly in the second. This creates a situation where the second environment can't import or use the package.
141141

142-
We recommend that you don't use `!pip install...` to install packages in Azure ML notebooks. Instead, use one of the following options:
142+
We recommend that you don't use `!pip install...` to install packages in Azure Machine Learning notebooks. Instead, use one of the following options:
143143

144144
- **Use the %pip line magic within a notebook**. Run:
145145

@@ -150,7 +150,7 @@ We recommend that you don't use `!pip install...` to install packages in Azure M
150150

151151
- **Install from a terminal**:
152152

153-
1. Open a terminal in Azure ML notebooks and run the following commands:
153+
1. Open a terminal in Azure Machine Learning notebooks and run the following commands:
154154

155155
``` bash
156156
conda activate azureml_py38
@@ -161,17 +161,17 @@ We recommend that you don't use `!pip install...` to install packages in Azure M
161161

162162
## Set an environment variable for your msticpyconfig.yaml file
163163

164-
If you are running in Azure ML and have your **msticpyconfig.yaml** file in the root of your user folder, MSTICPy will automatically find these settings. However, if you are running the notebooks in another environment, follow the instructions in this section to set an environment variable that points to the location of your configuration file.
164+
If you're running in Azure Machine Learning and have your **msticpyconfig.yaml** file in the root of your user folder, MSTICPy automatically finds these settings. However, if you're running the notebooks in another environment, follow the instructions in this section to set an environment variable that points to the location of your configuration file.
165165

166166
Defining the path to your **msticpyconfig.yaml** file in an environment variable allows you to store your file in a known location and make sure that you always load the same settings.
167167

168168
Use multiple configuration files, with multiple environment variables, if you want to use different settings for different notebooks.
169169

170170
1. Decide on a location for your **msticpyconfig.yaml** file, such as in **~/.msticpyconfig.yaml** or **%userprofile%/msticpyconfig.yaml**.
171171

172-
**Azure ML users**: If you store your configuration file in your Azure ML user folder, the MSTICPy `init_notebook` function (run in the initialization cell) will automatically find and use the file, and you do not need to set a **MSTICPYCONFIG** environment variable.
172+
**Azure ML users**: If you store your configuration file in your Azure Machine Learning user folder, the MSTICPy `init_notebook` function (run in the initialization cell) automatically finds and uses the file, and you don't need to set a **MSTICPYCONFIG** environment variable.
173173

174-
However, if you also have secrets stored in the file, we recommend storing the configuration file on the compute local drive. The compute internal storage is accessible only to the person who created the compute, whereas the shared storage is accessible to anyone with access to your Azure ML workspace.
174+
However, if you also have secrets stored in the file, we recommend storing the configuration file on the compute local drive. The compute internal storage is accessible only to the person who created the compute, whereas the shared storage is accessible to anyone with access to your Azure Machine Learning workspace.
175175

176176
For more information, see [What is an Azure Machine Learning compute instance?](/azure/machine-learning/concept-compute-instance).
177177

@@ -199,11 +199,11 @@ This procedure describes how to update the **.bashrc** file to set the **MSTICPY
199199

200200
1. Move the **msticpyconfig.yaml** file to the Compute instance as needed.
201201

202-
1. Open an Azure ML terminal, such as from the Microsoft Sentinel **Notebooks** page.
202+
1. Open an Azure Machine Learning terminal, such as from the Microsoft Sentinel **Notebooks** page.
203203

204204
1. Verify that you can access your **msticpyconfig.yaml** file.
205205

206-
In your Azure ML terminal, your current directory should be your Azure ML file store home directory, mounted in the Compute Linux system. The prompt looks similar to the following example:
206+
In your Azure Machine Learning terminal, your current directory should be your Azure Machine Learning file store home directory, mounted in the Compute Linux system. The prompt looks similar to the following example:
207207

208208
```python
209209
azureuser@alicecontoso-azml7:~/cloudfiles/code/Users/alicecontoso$
@@ -230,13 +230,13 @@ This procedure describes how to update the **.bashrc** file to set the **MSTICPY
230230
- If you moved the **msticpyconfig.yaml** file, run `export MSTICPYCONFIG=~/msticpyconfig.yaml`.
231231
- If you didn't move the **msticpyconfig.yaml** file, run `export MSTICPYCONFIG=~/cloudfiles/code/Users/<YOURNAME>/msticpyconfig.yaml`.
232232

233-
# [Azure ML options](#tab/azure-ml)
233+
# [Azure Machine Learning options](#tab/azure-ml)
234234

235-
If you need to store your **msticpyconfig.yaml** file somewhere other than your Azure ML user folder, use one of the following options:
235+
If you need to store your **msticpyconfig.yaml** file somewhere other than your Azure Machine Learning user folder, use one of the following options:
236236

237-
- **An *nbuser_settings.py* file at the root of your user folder**. While this process is simpler and less intrusive than editing the **kernel.json** file, it's only supported when you run the `init_notebook` function at the start of your notebook code. While this is the default behavior, if you run the notebook code without first running `init_notebook`, MSTICPy may not be able to find the configuration file.
237+
- **An *nbuser_settings.py* file at the root of your user folder**. While this process is simpler and less intrusive than editing the **kernel.json** file, it's only supported when you run the `init_notebook` function at the start of your notebook code. While this is the default behavior, if you run the notebook code without first running `init_notebook`, MSTICPy mmight not be able to find the configuration file.
238238

239-
1. In the Azure ML terminal, create the **nbuser_settings.py** file in the root of your user folder, which is the folder with your username.
239+
1. In the Azure Machine Learning terminal, create the **nbuser_settings.py** file in the root of your user folder, which is the folder with your username.
240240
1. In the **nbuser_settings.py** file, add the following lines:
241241

242242
```python
@@ -293,7 +293,7 @@ If you need to store your **msticpyconfig.yaml** file somewhere other than your
293293
---
294294

295295
> [!NOTE]
296-
> For the Linux and Windows options, you'll need to restart your Jupyter server for it to pick up the environment variable that you defined.
296+
> For the Linux and Windows options, you need to restart your Jupyter server for it to pick up the environment variable that you defined.
297297

298298
## Next steps
299299

0 commit comments

Comments
 (0)