Merge pull request #82 from microsoft/stmoor/updating-readme
Updating Readme to remove Api Key Requirement
This commit is contained in:
Коммит
ceaa14b792
|
@ -21,11 +21,6 @@ if ($PSVersionTable.PSVersion -gt [version]'5.1') {
|
|||
```
|
||||
Once the module is loaded, check out our [PowerShell samples](https://github.com/Microsoft/MSRC-Microsoft-Security-Updates-API/blob/master/src/README.md)
|
||||
|
||||
# API Keys
|
||||
The Security Updates API requires an API key. To obtain an API key please visit the [Security Update Guide Developer page](https://portal.msrc.microsoft.com/en-us/developer). For help using the Security Updates Guide please visit the [Security Updates Guide Community Forum](https://social.technet.microsoft.com/Forums/security/en-us/home?forum=securityupdateguide).
|
||||
|
||||
__NOTE: Generating an API key requires signing in with an @outlook.com, @live.com, or @microsoft.com email address. If you do not have one of these email addresses, you can create a personal outlook account to access this service. In the future, we will be removing this authentication requirement entirely.__
|
||||
|
||||
# Change Log
|
||||
**_For up to date major changes, please read the psd1 included in the src folder. This can also be seen on [the Microsoft Powershell Gallery](https://www.powershellgallery.com/packages/MsrcSecurityUpdates)._**
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Sample Code
|
||||
|
||||
The sample code serves as an example on how to interact with the MSRC Security Updates API through Powershell. You will need to log into the [MSRC Portal](https://portal.msrc.microsoft.com/en-us/developer) and obtain an API key.
|
||||
The sample code serves as an example on how to interact with the MSRC Security Updates API through Powershell.
|
||||
|
||||
In the PowerShell module, you will see script functions that show how to interact with the API, as well
|
||||
as functions that organize data from the industry-standard [CVRF document format](http://www.icasi.org/cvrf-v1-1-dictionary-of-elements/#40rem) to show some reporting scenarios.
|
||||
|
@ -64,7 +64,6 @@ In this common scenario, the *Get-MsrcCvrfDocument* and *Get-MsrcVulnerabilityRe
|
|||
### Install the module from the PowerShell Gallery (must be run as Admin)
|
||||
Install-Module -Name msrcsecurityupdates -force
|
||||
Import-module MsrcSecurityUpdates
|
||||
Set-MSRCApiKey -ApiKey "<your API key>" -Verbose
|
||||
$monthOfInterest = '2017-Apr'
|
||||
|
||||
Get-MsrcCvrfDocument -ID $monthOfInterest -Verbose |
|
||||
|
@ -77,7 +76,6 @@ You can also build a modified object to pass into *Get-MsrcVulnerabilityReportHt
|
|||
Install-Module -Name MsrcSecurityUpdates -Force
|
||||
Import-Module -Name MsrcSecurityUpdates -Force
|
||||
|
||||
Set-MSRCApiKey -ApiKey "<your API key>" -Verbose
|
||||
$monthOfInterest = "2017-Mar"
|
||||
|
||||
$CVEsWanted = @(
|
||||
|
@ -103,7 +101,6 @@ Building a report that contains all CVE's:
|
|||
### Install the module from the PowerShell Gallery (must be run as Admin)
|
||||
Install-Module -Name MsrcSecurityUpdates -Force
|
||||
Import-module MsrcSecurityUpdates
|
||||
Set-MSRCApiKey -ApiKey "<your API key>" -Verbose
|
||||
$monthOfInterest = '2017-Apr'
|
||||
|
||||
Get-MsrcCvrfDocument -ID $monthOfInterest -Verbose | Get-MsrcSecurityBulletinHtml -Verbose | Out-File c:\temp\MSRCAprilSecurityUpdates.html
|
||||
|
@ -115,7 +112,6 @@ Using powershell to filter the report to your liking:
|
|||
Install-Module -Name MsrcSecurityUpdates -Force
|
||||
Import-Module -Name MsrcSecurityUpdates -Force
|
||||
|
||||
Set-MSRCApiKey -ApiKey "<your API key>" -Verbose
|
||||
$monthOfInterest = "2017-Mar"
|
||||
|
||||
$CVEsWanted = @(
|
||||
|
|
Загрузка…
Ссылка в новой задаче