Skip to content

Commit 195e668

Browse files
Split Az.DataDog Examples (#17058)
1 parent 86b481a commit 195e668

18 files changed

+90
-42
lines changed

src/Datadog/help/Get-AzDatadogMarketplaceAgreement.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List Datadog marketplace agreements in the subscription.
2424

2525
### Example 1: List Datadog marketplace agreements in the subscription
2626
```powershell
27-
PS C:\> Get-AzDatadogMarketplaceAgreement
27+
Get-AzDatadogMarketplaceAgreement
28+
```
2829

30+
```output
2931
Name Type
3032
---- ----
3133
marketplace Microsoft.Datadog/agreements

src/Datadog/help/Get-AzDatadogMonitor.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,10 @@ Get the properties of a specific monitor resource.
4141

4242
### Example 1: List all monitor resources under a subscription
4343
```powershell
44-
PS C:\> Get-AzDatadogMonitor
44+
Get-AzDatadogMonitor
45+
```
4546

47+
```output
4648
Location Name Type
4749
-------- ---- ----
4850
eastus2euap Datadog microsoft.Datadog/monitors
@@ -52,8 +54,10 @@ This command lists all monitor resources under a subscription.
5254

5355
### Example 2: List monitor resources under a resource group
5456
```powershell
55-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog
57+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog
58+
```
5659

60+
```output
5761
Location Name Type
5862
-------- ---- ----
5963
eastus2euap Datadog microsoft.Datadog/monitors
@@ -63,8 +67,10 @@ This command lists all monitor resources under a resource group.
6367

6468
### Example 3: Get the properties of a specific monitor resource
6569
```powershell
66-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog
70+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog
71+
```
6772

73+
```output
6874
Location Name Type
6975
-------- ---- ----
7076
eastus2euap Datadog microsoft.Datadog/monitors
@@ -74,8 +80,10 @@ This command gets the properties of a specific monitor resource.
7480

7581
### Example 4: Get the properties of a specific monitor resource by pipeline
7682
```powershell
77-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Get-AzDatadogMonitor
83+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Get-AzDatadogMonitor
84+
```
7885

86+
```output
7987
Location Name Type
8088
-------- ---- ----
8189
eastus2euap Datadog microsoft.Datadog/monitors

src/Datadog/help/Get-AzDatadogMonitorApiKey.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List the api keys for a given monitor resource.
2424

2525
### Example 1: List the api keys for a given monitor resource
2626
```powershell
27-
PS C:\> Get-AzDatadogMonitorApiKey -ResourceGroupName azure-rg-Datadog -Name Datadog
27+
Get-AzDatadogMonitorApiKey -ResourceGroupName azure-rg-Datadog -Name Datadog
28+
```
2829

30+
```output
2931
Created CreatedBy Key Name
3032
------- --------- --- ----
3133
2021-05-24 07:25:35 [email protected] xxxxxxxxxxxx Azure Admin User API Key

src/Datadog/help/Get-AzDatadogMonitorDefaultKey.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Get the default api key.
3131

3232
### Example 1: Get the default api key
3333
```powershell
34-
PS C:\> Get-AzDatadogMonitorDefaultKey -ResourceGroupName azure-rg-Datadog -Name Datadog
34+
Get-AzDatadogMonitorDefaultKey -ResourceGroupName azure-rg-Datadog -Name Datadog
35+
```
3536

37+
```output
3638
Created CreatedBy Key Name
3739
------- --------- --- ----
3840
xxxxxxxxxxxxx
@@ -42,8 +44,10 @@ This command gets the default api key.
4244

4345
### Example 2: Get the default api key by pipeline
4446
```powershell
45-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Get-AzDatadogMonitorDefaultKey
47+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Get-AzDatadogMonitorDefaultKey
48+
```
4649

50+
```output
4751
Created CreatedBy Key Name
4852
------- --------- --- ----
4953
xxxxxxxxxxxxx

src/Datadog/help/Get-AzDatadogMonitorHost.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ List the hosts for a given monitor resource.
2424

2525
### Example 1: List the hosts for a given monitor resource
2626
```powershell
27-
PS C:\> Get-AzDatadogMonitorHost -ResourceGroupName azure-rg-Datadog -Name Datadog
28-
27+
Get-AzDatadogMonitorHost -ResourceGroupName azure-rg-Datadog -Name Datadog
2928
```
3029

3130
This command lists the hosts for a given monitor resource

src/Datadog/help/Get-AzDatadogMonitorLinkedResource.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List all Azure resources associated to the same Datadog organization as the targ
2424

2525
### Example 1: List all Azure resources associated to the same Datadog organization as the target resource
2626
```powershell
27-
PS C:\> Get-AzDatadogMonitorLinkedResource -ResourceGroupName azure-rg-Datadog -Name lucasDatadog
27+
Get-AzDatadogMonitorLinkedResource -ResourceGroupName azure-rg-Datadog -Name lucasDatadog
28+
```
2829

30+
```output
2931
Id
3032
--
3133
/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/EUAP-ACR-01266F2538192A/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-ACR-0126693370263

src/Datadog/help/Get-AzDatadogMonitorMonitoredResource.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ List the resources currently being monitored by the Datadog monitor resource.
2424

2525
### Example 1: List the resources currently being monitored by the Datadog monitor resource
2626
```powershell
27-
PS C:\> Get-AzDatadogMonitorMonitoredResource -ResourceGroupName azure-rg-Datadog -Name Datadog
28-
27+
Get-AzDatadogMonitorMonitoredResource -ResourceGroupName azure-rg-Datadog -Name Datadog
2928
```
3029

3130
This command lists the resources currently being monitored by the Datadog monitor resource.

src/Datadog/help/Get-AzDatadogSingleSignOnConfiguration.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Gets the datadog single sign-on resource for the given Monitor.
3737

3838
### Example 1: List the Datadog single sign-on resource for the given Monitor
3939
```powershell
40-
PS C:\> Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog
40+
Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog
41+
```
4142

43+
```output
4244
Name Type
4345
---- ----
4446
default microsoft.Datadog/monitors/singlesignonconfigurations
@@ -48,8 +50,10 @@ This command lists the Datadog single sign-on resource for the given Monitor.
4850

4951
### Example 2: Gets the Datadog single sign-on resource for the given Monitor
5052
```powershell
51-
PS C:\> Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default'
53+
Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default'
54+
```
5255

56+
```output
5357
Name Type
5458
---- ----
5559
default microsoft.Datadog/monitors/singlesignonconfigurations
@@ -59,8 +63,10 @@ This command gets the Datadog single sign-on resource for the given Monitor.
5963

6064
### Example 3: Gets the Datadog single sign-on resource for the given Monitor by pipeline
6165
```powershell
62-
PS C:\> New-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' -SingleSignOnState Enable -EnterpriseAppId 00000000-0000-0000-0000-000000000000 | Get-AzDatadogSingleSignOnConfiguration
66+
New-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' -SingleSignOnState Enable -EnterpriseAppId 00000000-0000-0000-0000-000000000000 | Get-AzDatadogSingleSignOnConfiguration
67+
```
6368

69+
```output
6470
Name Type
6571
---- ----
6672
default microsoft.Datadog/monitors/singlesignonconfigurations

src/Datadog/help/Get-AzDatadogTagRule.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ Get a tag rule set for a given monitor resource.
3636

3737
### Example 1: List all tag rules set for a given monitor resource
3838
```powershell
39-
PS C:\> Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog
39+
Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog
40+
```
4041

42+
```output
4143
Name Type
4244
---- ----
4345
default microsoft.Datadog/monitors/tagrules
@@ -47,8 +49,10 @@ This command lists all tag rules set for a given monitor resource.
4749

4850
### Example 2: Get a tag rule set for a given monitor resource
4951
```powershell
50-
PS C:\> Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default'
52+
Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default'
53+
```
5154

55+
```output
5256
Name Type
5357
---- ----
5458
default microsoft.Datadog/monitors/tagrules
@@ -58,8 +62,10 @@ This command gets a tag rule set for a given monitor resource.
5862

5963
### Example 3: Get a tag rule set for a given monitor resource by pipeline
6064
```powershell
61-
PS C:\> Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | Get-AzDatadogTagRule
65+
Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | Get-AzDatadogTagRule
66+
```
6267

68+
```output
6369
Name Type
6470
---- ----
6571
default microsoft.Datadog/monitors/tagrules

src/Datadog/help/New-AzDatadogFilteringTagObject.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ Create a in-memory object for FilteringTag
2323

2424
### Example 1: Create a in-memory object for FilteringTag
2525
```powershell
26-
PS C:\> New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment"
27-
26+
New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment"
2827
```
2928

3029
This command Create a in-memory object for FilteringTag.

src/Datadog/help/New-AzDatadogMarketplaceAgreement.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Create Datadog marketplace agreement in the subscription.
2626

2727
### Example 1: Create Datadog marketplace agreement in the subscription
2828
```powershell
29-
PS C:\> New-AzDatadogMarketplaceAgreement -Accepted
29+
New-AzDatadogMarketplaceAgreement -Accepted
30+
```
3031

32+
```output
3133
Name Type
3234
---- ----
3335
default microsoft.Datadog/agreements

src/Datadog/help/New-AzDatadogMonitor.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,10 @@ Create a monitor resource.
2929

3030
### Example 1: Create a monitor resource
3131
```powershell
32-
PS C:\> New-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-pwsh01 -SkuName 'drawdown_testing_20200904_Monthly' -Location 'eastus2euap' -UserInfoEmailAddress '[email protected]' -UserInfoName 'user' -UserInfoPhoneNumber 'xxxxxxxxxxxx' -IdentityType SystemAssigned
32+
New-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-pwsh01 -SkuName 'drawdown_testing_20200904_Monthly' -Location 'eastus2euap' -UserInfoEmailAddress '[email protected]' -UserInfoName 'user' -UserInfoPhoneNumber 'xxxxxxxxxxxx' -IdentityType SystemAssigned
33+
```
3334

35+
```output
3436
Location Name Type
3537
-------- ---- ----
3638
eastus2euap Datadog-pwsh01 microsoft.Datadog/monitors

src/Datadog/help/New-AzDatadogSingleSignOnConfiguration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ Configures single-sign-on for this resource.
3333

3434
### Example 1: Configures single-sign-on for Data monitor resource
3535
```powershell
36-
PS C:\> New-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' -SingleSignOnState Enable -EnterpriseAppId 00000000-0000-0000-0000-000000000000
36+
New-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' -SingleSignOnState Enable -EnterpriseAppId 00000000-0000-0000-0000-000000000000
37+
```
3738

39+
```output
3840
Name Type
3941
---- ----
4042
default microsoft.Datadog/monitors/singlesignonconfigurations
@@ -44,8 +46,10 @@ This command configures single-sign-on for Data monitor resource.
4446

4547
### Example 2: Configures single-sign-on for Data monitor resource by pipeline
4648
```powershell
47-
PS C:\> Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | New-AzDatadogSingleSignOnConfiguration -SingleSignOnState Disable -EnterpriseAppId 00000000-0000-0000-0000-000000000000
49+
Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | New-AzDatadogSingleSignOnConfiguration -SingleSignOnState Disable -EnterpriseAppId 00000000-0000-0000-0000-000000000000
50+
```
4851

52+
```output
4953
Name Type
5054
---- ----
5155
default microsoft.Datadog/monitors/singlesignonconfigurations

src/Datadog/help/New-AzDatadogTagRule.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,13 @@ Create or update a tag rule set for a given monitor resource.
3535

3636
### Example 1: Create or update a tag rule set for a given monitor resource
3737
```powershell
38-
PS C:\> $ftobjArray = @()
39-
PS C:\> $ftobjArray += New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment"
40-
PS C:\> $ftobjArray += New-AzDatadogFilteringTagObject -Action "Exclude" -Value "Dev" -Name "Environment"
41-
PS C:\> New-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'test' -LogRuleFilteringTag $ftobjArray
38+
$ftobjArray = @()
39+
$ftobjArray += New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment"
40+
$ftobjArray += New-AzDatadogFilteringTagObject -Action "Exclude" -Value "Dev" -Name "Environment"
41+
New-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'test' -LogRuleFilteringTag $ftobjArray
42+
```
4243

44+
```output
4345
Name Type
4446
---- ----
4547
default microsoft.Datadog/monitors/tagrules
@@ -49,11 +51,13 @@ This command creates or updates a tag rule set for a given monitor resource.
4951

5052
### Example 2: Create or update a tag rule set for a given monitor resource by pipeline
5153
```powershell
52-
PS C:\> $ftobjArray = @()
53-
PS C:\> $ftobjArray += New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment"
54-
PS C:\> $ftobjArray += New-AzDatadogFilteringTagObject -Action "Exclude" -Value "Dev" -Name "Environment"
55-
PS C:\> Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | New-AzDatadogTagRule -LogRuleFilteringTag $ftobjArray
54+
$ftobjArray = @()
55+
$ftobjArray += New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment"
56+
$ftobjArray += New-AzDatadogFilteringTagObject -Action "Exclude" -Value "Dev" -Name "Environment"
57+
Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | New-AzDatadogTagRule -LogRuleFilteringTag $ftobjArray
58+
```
5659

60+
```output
5761
Name Type
5862
---- ----
5963
default microsoft.Datadog/monitors/tagrules

src/Datadog/help/Remove-AzDatadogMonitor.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,14 @@ Delete a monitor resource.
3131

3232
### Example 1: Delete a monitor resource
3333
```powershell
34-
PS C:\> Remove-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-portal03
35-
34+
Remove-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-portal03
3635
```
3736

3837
This command deletes a monitor resource.
3938

4039
### Example 2: Delete a monitor resource by pipeline
4140
```powershell
42-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-portal02 | Remove-AzDatadogMonitor
43-
41+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-portal02 | Remove-AzDatadogMonitor
4442
```
4543

4644
This command deletes a monitor resource by pipeline.

src/Datadog/help/Set-AzDatadogMonitorDefaultKey.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ Set the default api key.
2525

2626
### Example 1: Set the default api key for monitor resource
2727
```powershell
28-
PS C:\> Set-AzDatadogMonitorDefaultKey -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Key 'xxxxxxxxxxxxxxxxxxxxxx'
28+
Set-AzDatadogMonitorDefaultKey -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Key 'xxxxxxxxxxxxxxxxxxxxxx'
29+
```
2930

31+
```output
3032
Created CreatedBy Key Name
3133
------- --------- --- ----
3234
xxxxxxxxxxxxxxxxxxxxxx

src/Datadog/help/Update-AzDatadogMonitor.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ Update a monitor resource.
3333

3434
### Example 1: Update a monitor resource
3535
```powershell
36-
PS C:\> Update-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog -Tag @{'key1'='value1'; 'key2'='value2'}
36+
Update-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog -Tag @{'key1'='value1'; 'key2'='value2'}
37+
```
3738

39+
```output
3840
Location Name Type
3941
-------- ---- ----
4042
eastus2euap Datadog microsoft.Datadog/monitors
@@ -44,7 +46,10 @@ This command updates a monitor resource.
4446

4547
### Example 2: Update a monitor resource by pipeline
4648
```powershell
47-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Update-AzDatadogMonitor -Tag @{'key1'='value1'; 'key2'='value2'}
49+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Update-AzDatadogMonitor -Tag @{'key1'='value1'; 'key2'='value2'}
50+
```
51+
52+
```output
4853
Location Name Type
4954
-------- ---- ----
5055
eastus2euap Datadog microsoft.Datadog/monitors

src/Datadog/help/Update-AzDatadogMonitorSetPasswordLink.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,21 @@ Refresh the set password link and return a latest one.
3131

3232
### Example 1: Refresh the set password link and return a latest one
3333
```powershell
34-
PS C:\> Update-AzDatadogMonitorSetPasswordLink -ResourceGroupName azure-rg-Datadog -Name Datadog
34+
Update-AzDatadogMonitorSetPasswordLink -ResourceGroupName azure-rg-Datadog -Name Datadog
35+
```
3536

37+
```output
3638
https://us3.Datadoghq.com/account/reset_password/xxxxxxxxxxxxxxxxxxxxxxxxxxx
3739
```
3840

3941
This command refresh the set password link and return a latest one.
4042

4143
### Example 2: Refresh the set password link and return a latest one by pipeline
4244
```powershell
43-
PS C:\> Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Update-AzDatadogMonitorSetPasswordLink
45+
Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Update-AzDatadogMonitorSetPasswordLink
46+
```
4447

48+
```output
4549
https://us3.Datadoghq.com/account/reset_password/xxxxxxxxxxxxxxxxxxxxxxxxxxx
4650
```
4751

0 commit comments

Comments
 (0)