Skip to content

Commit deaaa71

Browse files
author
TaraMeyer
committed
Adding back Service Management folder
1 parent 0a0ba10 commit deaaa71

File tree

4,968 files changed

+872158
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,968 files changed

+872158
-0
lines changed

‎azureps-cmdlets-docs/ServiceManagement/ServiceManagement/Azure.Antimalware/v0.9.8/Azure.Antimalware.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
Module Name: Azure.Antimalware
3+
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
4+
Download Help Link: {{Please enter FwLink manually}}
5+
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
6+
Locale: en-US
7+
ms.assetid: 37512B6C-A290-43DA-A397-D60002E7B160
8+
---
9+
10+
# Azure.Antimalware Module
11+
## Description
12+
This topic displays help topics for the Azure cmdlets for Microsoft Antimalware.
13+
14+
## Azure.Antimalware Cmdlets
15+
### [Get-AzureServiceAntimalwareConfig](./Get-AzureServiceAntimalwareConfig.md)
16+
Gets configuration details for the Microsoft Antimalware extension for a service.
17+
18+
19+
### [Get-AzureVMMicrosoftAntimalwareExtension](./Get-AzureVMMicrosoftAntimalwareExtension.md)
20+
Gets the Microsoft Antimalware extension details for a virtual machine.
21+
22+
23+
### [Remove-AzureServiceAntimalwareExtension](./Remove-AzureServiceAntimalwareExtension.md)
24+
Removes the antimalware configuration from a cloud service.
25+
26+
27+
### [Remove-AzureVMMicrosoftAntimalwareExtension](./Remove-AzureVMMicrosoftAntimalwareExtension.md)
28+
Removes the Microsoft Antimalware extension from a virtual machine.
29+
30+
31+
### [Set-AzureServiceAntimalwareExtension](./Set-AzureServiceAntimalwareExtension.md)
32+
Configures the Microsoft Antimalware extension for cloud services.
33+
34+
35+
### [Set-AzureVMMicrosoftAntimalwareExtension](./Set-AzureVMMicrosoftAntimalwareExtension.md)
36+
Configures the Microsoft Antimalware extension for a virtual machine.
37+
38+
39+

‎azureps-cmdlets-docs/ServiceManagement/ServiceManagement/Azure.Antimalware/v0.9.8/Get-AzureServiceAntimalwareConfig.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
external help file: Microsoft.WindowsAzure.Commands.ServiceManagement.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
ms.assetid: ED51D91A-9688-4595-AE4D-2D1A9A9234DF
6+
---
7+
8+
# Get-AzureServiceAntimalwareConfig
9+
10+
## SYNOPSIS
11+
Gets configuration details for the Microsoft Antimalware extension for a service.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-AzureServiceAntimalwareConfig [-ServiceName] <String> [[-Slot] <String>] [-Profile <AzureProfile>]
17+
[<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The **Get-AzureServiceAntimalwareConfig** cmdlet gets the antimalware configuration and monitoring configuration details associated with the Microsoft Antimalware extension for a cloud service.
22+
23+
## EXAMPLES
24+
25+
### Example 1: Get configuration for a service
26+
```
27+
PS C:\>Get-AzureServiceAntimalwareConfig -ServiceName "ContosoService03"
28+
```
29+
30+
This command returns the antimalware configuration object for the specified service name.
31+
Because this command does not specify the *Slot* parameter, the command gets the configuration for the default slot, Production.
32+
For services that have monitoring enabled, the command also returns a monitoring configuration object.
33+
34+
### Example 2: Get configuration for a service for the Staging slot
35+
```
36+
PS C:\>Get-AzureServiceAntimalwareConfig -ServiceName "ContosoService03" -Slot "Staging"
37+
```
38+
39+
This command returns the antimalware configuration object for the specified service name.
40+
Because this command specifies a value of Staging for the *Slot* parameter, the command gets the configuration for the Staging slot.
41+
For services that have monitoring enabled, the command also returns a monitoring configuration object.
42+
43+
## PARAMETERS
44+
45+
### -ServiceName
46+
Specifies the name of the cloud service.
47+
48+
```yaml
49+
Type: String
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: True
54+
Position: 0
55+
Default value: None
56+
Accept pipeline input: True (ByPropertyName)
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Slot
61+
Specifies a deployment slot.
62+
Valid values are:
63+
64+
- Production
65+
- Staging
66+
67+
The default value is Production.
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: 1
76+
Default value: None
77+
Accept pipeline input: True (ByPropertyName)
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Profile
82+
In-memory profile.
83+
84+
```yaml
85+
Type: AzureProfile
86+
Parameter Sets: (All)
87+
Aliases:
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### CommonParameters
97+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
98+
99+
## INPUTS
100+
101+
## OUTPUTS
102+
103+
## NOTES
104+
105+
## RELATED LINKS
106+
107+
[Remove-AzureServiceAntimalwareExtension](./Remove-AzureServiceAntimalwareExtension.md)
108+
109+
[Set-AzureServiceAntimalwareExtension](./Set-AzureServiceAntimalwareExtension.md)
110+
111+

‎azureps-cmdlets-docs/ServiceManagement/ServiceManagement/Azure.Antimalware/v0.9.8/Get-AzureVMMicrosoftAntimalwareExtension.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
external help file: Microsoft.WindowsAzure.Commands.ServiceManagement.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
ms.assetid: C8FCE2DE-0342-4690-B43B-3565A0FF0FDB
6+
---
7+
8+
# Get-AzureVMMicrosoftAntimalwareExtension
9+
10+
## SYNOPSIS
11+
Gets the Microsoft Antimalware extension details for a virtual machine.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-AzureVMMicrosoftAntimalwareExtension -VM <IPersistentVM> [-Profile <AzureProfile>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The **Get-AzureVMMicrosoftAntimalwareExtension** cmdlet gets the Microsoft Antimalware extension details for a virtual machine.
21+
This cmdlet gets details for virtual machines that have the extension turned on programmatically by using the **Set-AzureVMMicrosoftAntimalwareExtension** cmdlet.
22+
**Get-AzureVMMicrosoftAntimalwareExtension** gets the JavaScript Object Notation (JSON) equivalent for the configuration.
23+
If monitoring is turned on, the cmdlet also gets an XML representation of the antimalware monitoring configuration.
24+
25+
## EXAMPLES
26+
27+
### Example 1: Get information for the extension for a virtual machine
28+
```
29+
PS C:\>Get-AzureVM -ServiceName "ContosoService03" -Name "ContosoVM22" | Get-AzureVMMicrosoftAntimalwareExtension
30+
```
31+
32+
This command gets details for the Microsoft Antimalware extension for a virtual machine.
33+
The command uses the **Get-AzureVM** cmdlet to get the specified virtual machine object, and then passes the object to the current cmdlet by using the pipeline operator.
34+
**Get-AzureVMMicrosoftAntimalwareExtension** gets configuration information for the extension.
35+
36+
The configuration information appears in the output field labeled **AntimalwareConfiguration**.
37+
The configuration information for monitoring appears in the output field labeled **AntimalwareMonitoringConfiguration**.
38+
39+
## PARAMETERS
40+
41+
### -VM
42+
Specifies the virtual machine as an **IPersistentVM** object.
43+
44+
```yaml
45+
Type: IPersistentVM
46+
Parameter Sets: (All)
47+
Aliases: InputObject
48+
49+
Required: True
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: True (ByPropertyName, ByValue)
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Profile
57+
In-memory profile.
58+
59+
```yaml
60+
Type: AzureProfile
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### CommonParameters
72+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
73+
74+
## INPUTS
75+
76+
### IPersistentVM
77+
A virtual machine object.
78+
79+
## OUTPUTS
80+
81+
### VirtualMachineMicrosoftAntimalwareExtensionContext
82+
A context object that includes the JSON antimalware configuration.
83+
If monitoring is turned on, the object includes an XML representation of the antimalware monitoring configuration.
84+
85+
## NOTES
86+
87+
## RELATED LINKS
88+
89+
[Get-AzureVM](../../Azure.Service/v0.9.8/Get-AzureVM.md)
90+
91+
[Remove-AzureVMMicrosoftAntimalwareExtension](./Remove-AzureVMMicrosoftAntimalwareExtension.md)
92+
93+
[Set-AzureVMMicrosoftAntimalwareExtension](./Set-AzureVMMicrosoftAntimalwareExtension.md)
94+
95+

‎azureps-cmdlets-docs/ServiceManagement/ServiceManagement/Azure.Antimalware/v0.9.8/Remove-AzureServiceAntimalwareExtension.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
external help file: Microsoft.WindowsAzure.Commands.ServiceManagement.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
ms.assetid: B031388B-3E41-4CFC-94EA-1A18C211A422
6+
---
7+
8+
# Remove-AzureServiceAntimalwareExtension
9+
10+
## SYNOPSIS
11+
Removes the antimalware configuration from a cloud service.
12+
13+
## SYNTAX
14+
15+
### RemoveByRoles (Default)
16+
```
17+
Remove-AzureServiceAntimalwareExtension [-ServiceName] <String> [[-Slot] <String>] [[-Role] <String[]>]
18+
[[-EndpointSuffix] <String>] [-Profile <AzureProfile>] [<CommonParameters>]
19+
```
20+
21+
### RemoveAllRoles
22+
```
23+
Remove-AzureServiceAntimalwareExtension [-ServiceName] <String> [[-Slot] <String>] [[-EndpointSuffix] <String>]
24+
[-Profile <AzureProfile>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
The **Remove-AzureServiceAntimalwareExtension** cmdlet removes the antimalware configuration and any associated antimalware monitoring from the Microsoft Antimalware extension associated with a cloud service.
29+
30+
## EXAMPLES
31+
32+
### Example 1: Remove the extension
33+
```
34+
PS C:\>Remove-AzureServiceAntimalwareExtension -ServiceName "ContosoService03"
35+
```
36+
37+
This command removes the antimalware extension and monitoring of associated antimalware events from the service named ContosoService03.
38+
39+
### Example 2: Remove the extension for the Staging slot
40+
```
41+
PS C:\>Remove-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -Slot "Staging"
42+
```
43+
44+
This command removes the antimalware extension and monitoring of associated antimalware events from all roles in the staging slot of the service named ContosoService03.
45+
46+
### Example 3: Remove the extension for a specified slot and role
47+
```
48+
PS C:\>Remove-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -Slot "Production" -Role "web role"
49+
```
50+
51+
This command removes the antimalware extension and monitoring of associated antimalware events from the service named ContosoService03 in the specified slot and role.
52+
53+
## PARAMETERS
54+
55+
### -ServiceName
56+
Specifies the name of an Azure service.
57+
58+
```yaml
59+
Type: String
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: 0
65+
Default value: None
66+
Accept pipeline input: True (ByPropertyName)
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Slot
71+
Specifies the environment of the deployment.
72+
Valid values are: Staging or Production.
73+
The default value is Production.
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: (All)
78+
Aliases:
79+
80+
Required: False
81+
Position: 1
82+
Default value: None
83+
Accept pipeline input: True (ByPropertyName)
84+
Accept wildcard characters: False
85+
```
86+
87+
### -Role
88+
Specifies an array of roles.
89+
The default value is all roles.
90+
91+
```yaml
92+
Type: String[]
93+
Parameter Sets: RemoveByRoles
94+
Aliases:
95+
96+
Required: False
97+
Position: 2
98+
Default value: None
99+
Accept pipeline input: True (ByPropertyName)
100+
Accept wildcard characters: False
101+
```
102+
103+
### -EndpointSuffix
104+
Specifies the storage endpoint suffix.
105+
106+
```yaml
107+
Type: String
108+
Parameter Sets: (All)
109+
Aliases:
110+
111+
Required: False
112+
Position: 3
113+
Default value: None
114+
Accept pipeline input: True (ByPropertyName)
115+
Accept wildcard characters: False
116+
```
117+
118+
### -Profile
119+
In-memory profile.
120+
121+
```yaml
122+
Type: AzureProfile
123+
Parameter Sets: (All)
124+
Aliases:
125+
126+
Required: False
127+
Position: Named
128+
Default value: None
129+
Accept pipeline input: False
130+
Accept wildcard characters: False
131+
```
132+
133+
### CommonParameters
134+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
135+
136+
## INPUTS
137+
138+
## OUTPUTS
139+
140+
## NOTES
141+
* This cmdlet removes only the configuration associated with the specified role. It does not uninstall or remove any already running instances of the Microsoft Antimalware extension from roles. To return these roles to a start state that does not have Microsoft Antimalware running, first remove the configuration by using this cmdlet, and then reimage or redeploy the service.
142+
* To avoid interfering with monitoring for other applications or services, this cmdlet removes only the collection of Microsoft Antimalware events. It does not change other application configurations or the default monitoring configuration.
143+
144+
## RELATED LINKS
145+
146+
[Set-AzureServiceAntimalwareExtension](./Set-AzureServiceAntimalwareExtension.md)
147+
148+

0 commit comments

Comments
 (0)