Skip to content

Commit 17d5cbc

Browse files
authored
Update PIM specs for Documentation changes (#12815)
* PIM API Specs * update readme * Update * Update readme * operation id fix * name fix * Name changes * fix * Fix * Changes based on docs generated * Scope fix in example * Updates for documentation * Change operation name Co-authored-by: Aman Swaika <amansw@microsoft.com>
1 parent 2a6cde4 commit 17d5cbc

10 files changed

+25
-25
lines changed

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentSchedule.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"tags": [
4040
"roleAssignmentSchedules"
4141
],
42-
"operationId": "roleAssignmentSchedules_Get",
42+
"operationId": "RoleAssignmentSchedules_Get",
4343
"description": "Get the specified role assignment schedule for a resource scope",
4444
"parameters": [
4545
{
@@ -87,7 +87,7 @@
8787
"tags": [
8888
"roleAssignmentSchedules"
8989
],
90-
"operationId": "roleAssignmentSchedules_ListForScope",
90+
"operationId": "RoleAssignmentSchedules_ListForScope",
9191
"description": "Gets role assignment schedules for a resource scope.",
9292
"parameters": [
9393
{
@@ -103,7 +103,7 @@
103103
"in": "query",
104104
"required": false,
105105
"type": "string",
106-
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedules requested by the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user."
106+
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedules for the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user."
107107
},
108108
{
109109
"$ref": "#/parameters/ApiVersionParameter"

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentScheduleInstance.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"tags": [
4040
"roleAssignmentScheduleInstances"
4141
],
42-
"operationId": "roleAssignmentScheduleInstances_ListForScope",
42+
"operationId": "RoleAssignmentScheduleInstances_ListForScope",
4343
"description": "Gets role assignment schedule instances of a role assignment schedule.",
4444
"parameters": [
4545
{
@@ -55,7 +55,7 @@
5555
"in": "query",
5656
"required": false,
5757
"type": "string",
58-
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedules requested by the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user."
58+
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedule instances for the user. Use $filter=asTarget() to return all role assignment schedule instances created for the current user."
5959
},
6060
{
6161
"$ref": "#/parameters/ApiVersionParameter"
@@ -91,7 +91,7 @@
9191
"tags": [
9292
"roleAssignmentScheduleInstances"
9393
],
94-
"operationId": "roleAssignmentScheduleInstances_Get",
94+
"operationId": "RoleAssignmentScheduleInstances_Get",
9595
"description": "Gets the specified role assignment schedule instance.",
9696
"parameters": [
9797
{

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentScheduleRequest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@
404404
},
405405
"ticketSystem": {
406406
"type": "string",
407-
"description": "Ticket number for the role assignment"
407+
"description": "Ticket system name for the role assignment"
408408
}
409409
},
410410
"description": "Ticket Info of the role assignment"

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilitySchedule.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"tags": [
4040
"roleEligibilitySchedules"
4141
],
42-
"operationId": "roleEligibilitySchedules_Get",
42+
"operationId": "RoleEligibilitySchedules_Get",
4343
"description": "Get the specified role eligibility schedule for a resource scope",
4444
"parameters": [
4545
{
@@ -87,7 +87,7 @@
8787
"tags": [
8888
"roleEligibilitySchedules"
8989
],
90-
"operationId": "roleEligibilitySchedules_ListForScope",
90+
"operationId": "RoleEligibilitySchedules_ListForScope",
9191
"description": "Gets role eligibility schedules for a resource scope.",
9292
"parameters": [
9393
{
@@ -103,7 +103,7 @@
103103
"in": "query",
104104
"required": false,
105105
"type": "string",
106-
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedules requested by the current user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
106+
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
107107
},
108108
{
109109
"$ref": "#/parameters/ApiVersionParameter"

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilityScheduleInstance.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"tags": [
4040
"roleEligibilityScheduleInstances"
4141
],
42-
"operationId": "roleEligibilityScheduleInstances_ListForScope",
42+
"operationId": "RoleEligibilityScheduleInstances_ListForScope",
4343
"description": "Gets role eligibility schedule instances of a role eligibility schedule.",
4444
"parameters": [
4545
{
@@ -55,7 +55,7 @@
5555
"in": "query",
5656
"required": false,
5757
"type": "string",
58-
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedules requested by the current user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
58+
"description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
5959
},
6060
{
6161
"$ref": "#/parameters/ApiVersionParameter"
@@ -91,7 +91,7 @@
9191
"tags": [
9292
"roleEligibilityScheduleInstances"
9393
],
94-
"operationId": "roleEligibilityScheduleInstances_Get",
94+
"operationId": "RoleEligibilityScheduleInstances_Get",
9595
"description": "Gets the specified role eligibility schedule instance.",
9696
"parameters": [
9797
{

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilityScheduleRequest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@
400400
},
401401
"ticketSystem": {
402402
"type": "string",
403-
"description": "Ticket number for the role eligibility"
403+
"description": "Ticket system name for the role eligibility"
404404
}
405405
},
406406
"description": "Ticket Info of the role eligibility"

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"tags": [
4040
"roleManagementPolicies"
4141
],
42-
"operationId": "roleManagementPolicies_Get",
42+
"operationId": "RoleManagementPolicies_Get",
4343
"description": "Get the specified role management policy for a resource scope",
4444
"parameters": [
4545
{
@@ -85,7 +85,7 @@
8585
"tags": [
8686
"roleManagementPolicies"
8787
],
88-
"operationId": "roleManagementPolicies_Create",
88+
"operationId": "RoleManagementPolicies_Update",
8989
"description": "Update or create a role management policy",
9090
"parameters": [
9191
{
@@ -140,7 +140,7 @@
140140
"tags": [
141141
"roleManagementPolicies"
142142
],
143-
"operationId": "roleManagementPolicies_Delete",
143+
"operationId": "RoleManagementPolicies_Delete",
144144
"description": "Delete a role management policy",
145145
"parameters": [
146146
{
@@ -188,7 +188,7 @@
188188
"tags": [
189189
"roleManagementPolicies"
190190
],
191-
"operationId": "roleManagementPolicies_ListForScope",
191+
"operationId": "RoleManagementPolicies_ListForScope",
192192
"description": "Gets role management policies for a resource scope.",
193193
"parameters": [
194194
{

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicyAssignment.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"tags": [
4040
"roleManagementPolicyAssignments"
4141
],
42-
"operationId": "roleManagementPolicyAssignments_Get",
42+
"operationId": "RoleManagementPolicyAssignments_Get",
4343
"description": "Get the specified role management policy assignment for a resource scope",
4444
"parameters": [
4545
{
@@ -85,7 +85,7 @@
8585
"tags": [
8686
"roleManagementPolicyAssignments"
8787
],
88-
"operationId": "roleManagementPolicyAssignments_Create",
88+
"operationId": "RoleManagementPolicyAssignments_Create",
8989
"description": "Create a role management policy assignment",
9090
"parameters": [
9191
{
@@ -140,7 +140,7 @@
140140
"tags": [
141141
"roleManagementPolicyAssignments"
142142
],
143-
"operationId": "roleManagementPolicyAssignments_Delete",
143+
"operationId": "RoleManagementPolicyAssignments_Delete",
144144
"description": "Delete a role management policy assignment",
145145
"parameters": [
146146
{
@@ -188,7 +188,7 @@
188188
"tags": [
189189
"roleManagementPolicyAssignments"
190190
],
191-
"operationId": "roleManagementPolicyAssignments_ListForScope",
191+
"operationId": "RoleManagementPolicyAssignments_ListForScope",
192192
"description": "Gets role management assignment policies for a resource scope.",
193193
"parameters": [
194194
{

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyByScope.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"parameters": {
3-
"scope": "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
3+
"scope": "subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3",
44
"api-version": "2020-10-01-preview"
55
},
66
"responses": {

specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/PutRoleManagementPolicyAssignment.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"parameters": {
77
"properties": {
88
"scope": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3",
9-
"roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
9+
"roleDefinitionId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
1010
"policyId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/RoleManagementPolicies/477f2d04-0fdc-417f-ab1b-d9fff8137134"
1111
}
1212
}
@@ -16,7 +16,7 @@
1616
"body": {
1717
"properties": {
1818
"scope": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3",
19-
"roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
19+
"roleDefinitionId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
2020
"policyId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/RoleManagementPolicies/477f2d04-0fdc-417f-ab1b-d9fff8137134"
2121
},
2222
"name": "477f2d04-0fdc-417f-ab1b-d9fff8137134_a37489be-9462-48fb-a3b6-7b9bc2debbad",

0 commit comments

Comments
 (0)