Skip to content

Commit 85e6ef7

Browse files
Split Az.Purview Examples (#17293)
1 parent 83a1cf8 commit 85e6ef7

10 files changed

+42
-24
lines changed

src/Purview/help/Add-AzPurviewAccountRootCollectionAdmin.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,15 @@ Add the administrator for root collection associated with this account.
3131

3232
### Example 1: Add the administrator for root collection
3333
```powershell
34-
PS C:\> Add-AzPurviewAccountRootCollectionAdmin -AccountName test-pa -ResourceGroupName test-rg -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0
35-
34+
Add-AzPurviewAccountRootCollectionAdmin -AccountName test-pa -ResourceGroupName test-rg -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0
3635
```
3736

3837
Add the administrator for root collection associated with the account named 'test-pa'.
3938

4039
### Example 2: Add the administrator for root collection by InputObject
4140
```powershell
42-
PS C:\> $got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
43-
PS C:\> Add-AzPurviewAccountRootCollectionAdmin -InputObject $got -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0
41+
$got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
42+
Add-AzPurviewAccountRootCollectionAdmin -InputObject $got -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0
4443
```
4544

4645
Add the administrator for root collection associated with the account named 'test-pa' by InputObject.

src/Purview/help/Get-AzPurviewAccount.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ Get an account
4242

4343
### Example 1: List All Purview Accounts
4444
```powershell
45-
PS C:\> Get-AzPurviewAccount
45+
Get-AzPurviewAccount
46+
```
4647

48+
```output
4749
IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType
4850
------------------- ---------------- ------------ -------- ---- ------------------- ------------------- --------
4951
xxxxxxxx-a087-43aa-8a7f-c17a4bbd4d36 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus pvac 8/4/2021 8:34:28 AM [email protected] User
@@ -55,8 +57,10 @@ List all purview accounts.
5557

5658
### Example 2: Get Purview Account by Resource Group Name and Name
5759
```powershell
58-
PS C:\> Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
60+
Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
61+
```
5962

63+
```output
6064
IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt
6165
------------------- ---------------- ------------ -------- ---- ------------------- ------------------- ----------------------- -----------------
6266
xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM [email protected] User 8/17/2021 6:18:5…
@@ -66,8 +70,10 @@ Get the purview account name test-rg in resource group test-pa
6670

6771
### Example 3: List Purview Accounts in a Specified Resource Group
6872
```powershell
69-
PS C:\> Get-AzPurviewAccount -ResourceGroupName test-rg
73+
Get-AzPurviewAccount -ResourceGroupName test-rg
74+
```
7075

76+
```output
7177
IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt
7278
------------------- ---------------- ------------ -------- ---- ------------------- ------------------- ----------------------- -----------------
7379
xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM [email protected] User 8/17/2021 6:18:5…
@@ -77,10 +83,11 @@ List the purview accounts in resource group test-pa
7783

7884
### Example 4: Get Purview Account by InputObject
7985
```powershell
80-
PS C:\> $got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
81-
PS C:\> Get-AzADDomainService -InputObject $got
82-
86+
$got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
87+
Get-AzADDomainService -InputObject $got
88+
```
8389

90+
```output
8491
IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt
8592
------------------- ---------------- ------------ -------- ---- ------------------- ------------------- ----------------------- -----------------
8693
xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM [email protected] User 8/17/2021 6:18:5…

src/Purview/help/Get-AzPurviewAccountKey.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List the authorization keys associated with this account.
2424

2525
### Example 1: List the authorization keys associated with a specified account.
2626
```powershell
27-
PS C:\> Get-AzPurviewAccountKey -AccountName test-pa -ResourceGroupName test-rg
27+
Get-AzPurviewAccountKey -AccountName test-pa -ResourceGroupName test-rg
28+
```
2829

30+
```output
2931
AtlasKafkaPrimaryEndpoint
3032
-------------------------
3133
Endpoint=sb://atlas-xxxxxxxx-5348-4811-a336-759242a25d37.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAcces…

src/Purview/help/Get-AzPurviewDefaultAccount.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Get the default account for the scope.
2424

2525
### Example 1: Get the default account for the scope Tenant.
2626
```powershell
27-
PS C:\> Get-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant
27+
Get-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant
28+
```
2829

30+
```output
2931
AccountName ResourceGroupName Scope ScopeTenantId ScopeType SubscriptionId
3032
----------- ----------------- ----- ------------- --------- --------------
3133
test-pa test-rg xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a Tenant xxxxxxxx-1bf0-4dda-aec3

src/Purview/help/New-AzPurviewAccount.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Creates or updates an account
2626

2727
### Example 1: Create a purview account
2828
```powershell
29-
PS C:\> New-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Location eastus -IdentityType SystemAssigned -SkuCapacity 4 -SkuName Standard
29+
New-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Location eastus -IdentityType SystemAssigned -SkuCapacity 4 -SkuName Standard
30+
```
3031

32+
```output
3133
IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy
3234
------------------- ---------------- ------------ -------- ---- ------------------- -----------
3335
xxxxxxxx-9e08-4873-8b0d-1442be9e5b14 54826b22-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 7:47:10 AM xxx.xxx…

src/Purview/help/Remove-AzPurviewAccount.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,15 @@ Deletes an account resource
3131

3232
### Example 1: Delete a purview account
3333
```powershell
34-
PS C:\> Remove-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
35-
34+
Remove-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
3635
```
3736

3837
Delete a purview account named 'test-pa'
3938

4039
### Example 2: Delete a purview account by InputObject
4140
```powershell
42-
PS C:\> $get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
43-
PS C:\> Remove-AzPurviewAccount -InputObject $get
44-
41+
$get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
42+
Remove-AzPurviewAccount -InputObject $get
4543
```
4644

4745
Delete a purview account named 'test-pa' by InputObject

src/Purview/help/Remove-AzPurviewDefaultAccount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Removes the default account from the scope.
2424

2525
### Example 1: Removes the default account from the scope
2626
```powershell
27-
PS C:\> Remove-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant
27+
Remove-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant
2828
```
2929

3030
Removes the default account from the scope Tenant.

src/Purview/help/Set-AzPurviewDefaultAccount.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ Sets the default account for the scope.
2525

2626
### Example 1: Sets the default account for the scope.
2727
```powershell
28-
PS C:\> Set-AzPurviewDefaultAccount -AccountName test-pa -ResourceGroupName test-rg -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a
28+
Set-AzPurviewDefaultAccount -AccountName test-pa -ResourceGroupName test-rg -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a
29+
```
2930

31+
```output
3032
AccountName ResourceGroupName Scope ScopeTenantId ScopeType SubscriptionId
3133
----------- ----------------- ----- ------------- --------- --------------
3234
test-pa test-rg xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a Tenant xxxxxxxx-1bf0-4dda-aec3

src/Purview/help/Test-AzPurviewAccountNameAvailability.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Checks if account name is available.
2424

2525
### Example 1: Check if account name is available
2626
```powershell
27-
PS C:\> Test-AzPurviewAccountNameAvailability -Name test-pa -Type Tenant
27+
Test-AzPurviewAccountNameAvailability -Name test-pa -Type Tenant
28+
```
2829

30+
```output
2931
Message NameAvailable Reason
3032
------- ------------- ------
3133
The name test-pa is invalid, please use another name. False Invalid

src/Purview/help/Update-AzPurviewAccount.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ Updates an account
3333

3434
### Example 1: Update a purview account
3535
```powershell
36-
PS C:\> Update-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Tag @{"k"="v"} | fl
36+
Update-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Tag @{"k"="v"} | fl
37+
```
3738

39+
```output
3840
CloudConnectorAwsExternalId : xxxxxxxxxx-d074-4f8f-9d7f-10811b250738
3941
CreatedAt : 8/17/2021 6:18:57 AM
4042
CreatedBy : [email protected]
@@ -91,9 +93,11 @@ Update the tag of a purview account named 'test-pa'
9193

9294
### Example 2: Update a purview account by InputObject
9395
```powershell
94-
PS C:\> $get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
95-
PS C:\> Update-AzPurviewAccount -InputObject $get -Tag @{"k"="v"}
96+
$get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
97+
Update-AzPurviewAccount -InputObject $get -Tag @{"k"="v"}
98+
```
9699

100+
```output
97101
CloudConnectorAwsExternalId : xxxxxxxxxx-d074-4f8f-9d7f-10811b250738
98102
CreatedAt : 8/17/2021 6:18:57 AM
99103
CreatedBy : [email protected]

0 commit comments

Comments
 (0)