Skip to content

Commit

Permalink
format the help markdown files of Az.Resources in generation (#18694)
Browse files Browse the repository at this point in the history 
* format the help markdown files of Az.Resources in generation

* fix

* Update New-AzADAppCredential.md

Co-authored-by: Ziyue Zheng <[email protected]>
  • Loading branch information
@CaptainFanZzz @ziyuezh576
CaptainFanZzz and ziyuezh576 authored Jul 4, 2022
1 parent 371c637 commit ee551ba
Show file tree
Hide file tree
Showing 42 changed files with 384 additions and 226 deletions.
26 changes: 17 additions & 9 deletions src/Resources/Authorization.Autorest/docs/Get-AzRoleAssignmentSchedule.md
View file
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/Authorization.Autorest/docs/Get-AzRoleAssignmentScheduleInstance.md
View file
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/Authorization.Autorest/docs/Get-AzRoleAssignmentScheduleRequest.md
View file
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 @@ -67,9 +71,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 @@ -82,9 +88,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/Authorization.Autorest/docs/Get-AzRoleEligibilitySchedule.md
View file
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

0 comments on commit ee551ba

Please sign in to comment.