Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format the help markdown files of Az.Resources #18693

Merged
merged 2 commits into from
Jun 28, 2022
Merged

format the help markdown files of Az.Resources #18693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b996264
format the help markdown files of Az.Resources
CaptainFanZzz Jun 23, 2022
8e831ad
Update Set-AzManagedApplication.md
ziyuezh576 Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Resources/Resources/help/Get-AzADAppFederatedIdentityCredential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ Get federatedIdentityCredentials by Id from applications.

### Example 1: List federated identity credentials for application
```powershell
Get-AzADApplication -ObjectId $app | Get-AzADAppFederatedCredential
Get-AzADApplication -ObjectId $app | Get-AzADAppFederatedIdentityCredential
```

List federated identity credentials for application

### Example 2: Get federated identity credential by id
```powershell
Get-AzADAppFederatedCredential -ApplicationObjectId $appObjectId -Id $credentialId
Get-AzADAppFederatedIdentityCredential -ApplicationObjectId $appObjectId -Id $credentialId
```

Get federated identity credential by id
Expand Down
12 changes: 6 additions & 6 deletions src/Resources/Resources/help/Get-AzPrivateLinkAssociation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ The Get-AzPrivateLinkAssociation cmdlet gets all of resource management private

### Example 1
```powershell
PS C:\> Get-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d | fl


Get-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d | Format-List
```

```output
Id : /providers/Microsoft.Management/managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d/providers/Microsoft.
Authorization/privateLinkAssociations/7afcb623-ff23-591c-8cdd-57f5357711f4
Type : Microsoft.Authorization/privateLinkAssociations
Expand All @@ -51,10 +51,10 @@ Get all the private link associations at the managment group scope.

### Example 2
```powershell
PS C:\> Get-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d -Name 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 | fl


Get-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d -Name 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 | Format-List
```

```output
Id : /providers/Microsoft.Management/managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d/providers/Microsoft.
Authorization/privateLinkAssociations/1d7942d1-288b-48de-8d0f-2d2aa8e03ad4
Type : Microsoft.Authorization/privateLinkAssociations
Expand Down
15 changes: 9 additions & 6 deletions src/Resources/Resources/help/Get-AzResourceManagementPrivateLink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ The Get-AzResourceManagementPrivateLink cmdlet gets a specific resource manageme

### Example 1
```powershell
PS C:\> Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG -Name NewPL

Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG -Name NewPL
```

```output
Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi
ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL
Type : Microsoft.Authorization/resourceManagementPrivateLinks
Expand All @@ -39,9 +40,10 @@ Get the resource management private link with the private endpoint connections a

### Example 2
```powershell
PS C:\> Get-AzResourceManagementPrivateLink

Get-AzResourceManagementPrivateLink
```

```output
Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi
ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL
Type : Microsoft.Authorization/resourceManagementPrivateLinks
Expand All @@ -61,9 +63,10 @@ Gets all of the resoure management private links at the subscription scope.

### Example 3
```powershell
PS C:\> Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG

Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG
```

```output
Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi
ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL
Type : Microsoft.Authorization/resourceManagementPrivateLinks
Expand Down
26 changes: 17 additions & 9 deletions src/Resources/Resources/help/Get-AzRoleAssignmentSchedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@ Get the specified role assignment schedule for a resource scope

### Example 1: List all role assignment schedules for a resource
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentSchedule -Scope $scope
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentSchedule -Scope $scope
```

```output
Name Type Scope
---- ---- -----
986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d
Expand All @@ -52,9 +54,11 @@ To call the API, you must have access to the `Microsoft.Authorization/roleAssign

### Example 2: List all My role assignment schedules for a resource
```powershell
PS C:\> $scope = "/" # "/" stands for tenant level resource
PS C:\> Get-AzRoleAssignmentSchedule -Scope $scope -Filter "asTarget()"
$scope = "/" # "/" stands for tenant level resource
Get-AzRoleAssignmentSchedule -Scope $scope -Filter "asTarget()"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio…
Expand All @@ -67,10 +71,12 @@ Returns all `roleAssignmentSchedules` for the `scope` which are assigned to the

### Example 3: List all role assignment schedules for a resource with filters
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> $filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'"
PS C:\> Get-AzRoleAssignmentSchedule -Scope $scope -Filter $filter
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'"
Get-AzRoleAssignmentSchedule -Scope $scope -Filter $filter
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/…
Expand Down Expand Up @@ -98,9 +104,11 @@ Supported filters:

### Example 4: Get a role assignment schedule by scope and name
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentSchedule -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentSchedule -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/…
Expand Down
26 changes: 17 additions & 9 deletions src/Resources/Resources/help/Get-AzRoleAssignmentScheduleInstance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ Gets the specified role assignment schedule instance.

### Example 1: List all role assignment schedule instances for a resource
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentScheduleInstance -Scope $scope
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentScheduleInstance -Scope $scope
```

```output
Name Type Scope
---- ---- -----
986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d
Expand All @@ -53,9 +55,11 @@ To call the API, you must have access to the `Microsoft.Authorization/roleAssign

### Example 2: List all My role assignment schedule instances for a resource
```powershell
PS C:\> $scope = "/" # "/" stands for tenant level resource
PS C:\> Get-AzRoleAssignmentScheduleInstance -Scope $scope -Filter "asTarget()"
$scope = "/" # "/" stands for tenant level resource
Get-AzRoleAssignmentScheduleInstance -Scope $scope -Filter "asTarget()"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio…
Expand All @@ -68,10 +72,12 @@ Returns all `roleAssignmentScheduleInstances` for the `scope` which are assigned

### Example 3: List all role assignment schedule instances for a resource with filters
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> $filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'"
PS C:\> Get-AzRoleAssignmentScheduleInstance -Scope $scope -Filter $filter
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'"
Get-AzRoleAssignmentScheduleInstance -Scope $scope -Filter $filter
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/…
Expand Down Expand Up @@ -99,9 +105,11 @@ Supported filters:

### Example 4: Get a role assignment schedule instances by scope and name
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentScheduleInstance -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentScheduleInstance -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/…
Expand Down
24 changes: 16 additions & 8 deletions src/Resources/Resources/help/Get-AzRoleAssignmentScheduleRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ Get the specified role assignment schedule request.

### Example 1: List all role assignment schedule requests for a resource
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentScheduleRequest -Scope $scope
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentScheduleRequest -Scope $scope
```

```output
Name Type Scope
---- ---- -----
01b86d0b-2d7d-4ee2-bedb-68417ca9cc6a Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d
Expand All @@ -52,9 +54,11 @@ Returns all `roleAssignmentScheduleRequests` for the `scope`.

### Example 2: List all My role assignment schedule requests for a resource
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentScheduleRequest -Scope $scope -Filter "asTarget()"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentScheduleRequest -Scope $scope -Filter "asTarget()"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov…
Expand All @@ -66,9 +70,11 @@ Returns all `roleAssignmentScheduleRequests` for the `scope` which are assigned

### Example 3: List all role assignment schedule requests for a resource where calling user is an approver
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentScheduleRequest -Scope $scope -Filter "asApprover()"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentScheduleRequest -Scope $scope -Filter "asApprover()"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov…
Expand All @@ -80,9 +86,11 @@ Returns all `roleAssignmentScheduleRequests` for the `scope` on which the callin

### Example 4: Get a role assignment schedule request by scope and name
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
PS C:\> Get-AzRoleAssignmentScheduleRequest -Scope $scope -Name "2cc018c2-27f8-4730-a0bc-b6a8fcee3e70"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleAssignmentScheduleRequest -Scope $scope -Name "2cc018c2-27f8-4730-a0bc-b6a8fcee3e70"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authoriz…
Expand Down
16 changes: 12 additions & 4 deletions src/Resources/Resources/help/Get-AzRoleEligibilitySchedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@ Get the specified role eligibility schedule for a resource scope

### Example 1: List all role eligible schedules for a resource
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleEligibilitySchedule -Scope $scope
```

```output
Name Type Scope
---- ---- -----
986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d
Expand All @@ -52,9 +54,11 @@ To call the API, you must have access to the `Microsoft.Authorization/roleAssign

### Example 2: List all My role eligible schedules for a resource
```powershell
PS C:\> $scope = "/" # "/" stands for tenant level resource
$scope = "/" # "/" stands for tenant level resource
Get-AzRoleEligibilitySchedule -Scope $scope -Filter "asTarget()"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio…
Expand All @@ -67,10 +71,12 @@ Returns all `roleEligibilitySchedules` for the `scope` which are assigned to the

### Example 3: List all role eligible schedules for a resource with filters
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'"
Get-AzRoleEligibilitySchedule -Scope $scope -Filter $filter
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/…
Expand Down Expand Up @@ -98,9 +104,11 @@ Supported filters:

### Example 4: Get a role eligible schedules by scope and name
```powershell
PS C:\> $scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d"
Get-AzRoleEligibilitySchedule -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18"
```

```output
Name Type Scope RoleDefinitionId
---- ---- ----- ----------------
4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/…
Expand Down
Loading