swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Roles API schemes: - https tags: - name: Roles paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName} : get: description: Gets information about a cluster role. tags: - Roles operationId: microsoftAzureRolesGet x-ms-examples: Get the role of the cluster: $ref: ./examples/RoleGet.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/RoleNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/Role' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Roles Rolename put: tags: - Roles operationId: microsoftAzureRolesCreate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: RoleCreate: $ref: ./examples/RoleCreate.json description: Creates a new role or updates an existing role. parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/RoleNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Role' description: The required parameters for creating or updating a role. responses: '200': description: OK schema: $ref: '#/definitions/Role' '201': description: Accepted schema: $ref: '#/definitions/Role' headers: location: type: string azure-async-operation: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Roles Rolename delete: tags: - Roles operationId: microsoftAzureRolesDelete x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: RoleDelete: $ref: ./examples/RoleDelete.json description: Deletes a cluster role. parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/RoleNameParameter' responses: '202': description: Accepted headers: location: type: string azure-async-operation: type: string '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Roles Rolename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles : get: tags: - Roles operationId: microsoftAzureRolesListbycluster x-ms-examples: RoleList: $ref: ./examples/RoleListByCluster.json description: List all the roles in a given cluster. parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/RoleListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Roles /roles: get: operationId: microsoftAzureRolesList summary: Microsoft Azure Get The List Of Roles In An Application x-ms-examples: List roles: $ref: ./examples/roles_list.json parameters: - $ref: '#/parameters/Version' x-ms-pageable: nextLinkName: nextLink responses: '200': description: Success schema: $ref: '#/definitions/RoleCollection' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Roles /roles/{roleId}: get: operationId: microsoftAzureRolesGet summary: Microsoft Azure Get A Role By Id x-ms-examples: Get role by ID: $ref: ./examples/roles_get.json parameters: - $ref: '#/parameters/Version' - in: path name: roleId description: Unique ID for the role. type: string required: true responses: '200': description: Success schema: $ref: '#/definitions/Role_2' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Roles ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roles : get: tags: - Roles operationId: microsoftAzureRolesListbyhub x-ms-examples: Roles_ListByHub: $ref: ./examples/RolesListByHub.json description: Gets all the roles for the hub. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get all the roles in the hub. schema: $ref: '#/definitions/RoleListResult_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Roles ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles : get: tags: - Roles description: Lists all the roles configured in a Data Box Edge/Data Box Gateway device. operationId: microsoftAzureRolesListbydataboxedgedevice parameters: - name: deviceName in: path description: The device name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: List of all the roles configured in the device. schema: $ref: '#/definitions/RoleList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: RoleGetAllInDevice: $ref: ./examples/RoleGetAllInDevice.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name} : get: tags: - Roles description: Gets a specific role by name. operationId: microsoftAzureRolesGet parameters: - name: deviceName in: path description: The device name. required: true type: string - name: name in: path description: The role name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The role with the specified name in the given device. schema: $ref: '#/definitions/Role_4' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: RoleGet: $ref: ./examples/RoleGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Name put: tags: - Roles description: Create or update a role. operationId: microsoftAzureRolesCreateorupdate parameters: - name: deviceName in: path description: The device name. required: true type: string - name: name in: path description: The role name. required: true type: string - name: role in: body description: The role properties. required: true schema: $ref: '#/definitions/Role_4' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully created or updated the role. schema: $ref: '#/definitions/Role_4' '202': description: Accepted the request to create or update the role. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: RolePut: $ref: ./examples/RolePut.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Name delete: tags: - Roles description: Deletes the role on the device. operationId: microsoftAzureRolesDelete parameters: - name: deviceName in: path description: The device name. required: true type: string - name: name in: path description: The role name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted the role. '202': description: Accepted the request to delete the role. '204': description: The role is already deleted. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: RoleDelete: $ref: ./examples/RoleDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Roles Name ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName} : put: tags: - Roles operationId: microsoftAzureRolesCreate x-ms-long-running-operation: true x-ms-examples: RoleCreate: $ref: ./examples/RoleCreate.json description: Creates a new role or updates an existing role. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServerGroupNameParameter' - $ref: '#/parameters/RoleNameParameter_2' - name: parameters in: body required: true schema: $ref: '#/definitions/Role_5' description: The required parameters for creating or updating a role. responses: '200': description: OK schema: $ref: '#/definitions/Role_5' '201': description: Created schema: $ref: '#/definitions/Role_5' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Roles Rolename delete: tags: - Roles operationId: microsoftAzureRolesDelete x-ms-long-running-operation: true x-ms-examples: RoleDelete: $ref: ./examples/RoleDelete.json description: Deletes a server group role. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServerGroupNameParameter' - $ref: '#/parameters/RoleNameParameter_2' responses: '200': description: OK '202': description: Accepted '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Roles Rolename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles : get: tags: - Roles operationId: microsoftAzureRolesListbyservergroup x-ms-examples: RoleList: $ref: ./examples/RoleListByServerGroup.json description: List all the roles in a given server group. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServerGroupNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/RoleListResult_3' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Roles definitions: RoleListResult: properties: value: type: array items: $ref: '#/definitions/Role' description: The list of roles in a cluster. description: A list of roles. type: object RoleProperties: properties: roleType: type: string enum: - user - admin default: user x-ms-enum: name: RoleType modelAsString: true password: type: string x-ms-secret: true format: password x-ms-mutability: - create - update description: The password of the cluster role. If an identity is used, password will not be required. externalIdentity: type: object required: - objectId - principalType properties: objectId: type: string format: arm-id principalType: type: string enum: - user - servicePrincipal - group x-ms-enum: name: PrincipalType modelAsString: true tenantId: type: string format: arm-id x-ms-client-flatten: true provisioningState: $ref: '#/definitions/ProvisioningState' description: Provisioning state of the role readOnly: true description: The properties of a cluster role. type: object RoleListResult_3: properties: value: type: array items: $ref: '#/definitions/Role_5' description: The list of roles in a server group. description: A list of roles. ProxyResource: properties: id: readOnly: true type: string description: Resource ID. name: readOnly: true type: string description: Resource name. type: readOnly: true type: string description: Resource type. x-ms-azure-resource: true description: Common properties of proxy resource. ErrorDetails: description: The detail information of the error. type: object properties: code: type: string description: Error code. message: type: string description: Error message details. requestId: type: string description: Correlation Id for current request. time: type: string format: date-time-rfc1123 description: The time that error request failed. required: - code - message RoleResourceFormat: description: The role resource format. properties: properties: x-ms-client-flatten: true $ref: '#/definitions/Role_3' allOf: - $ref: '#/definitions/ProxyResource' RoleProperties_2: properties: password: type: string x-ms-secret: true format: password x-ms-mutability: - create - update description: The password of the server group role. required: - password description: The properties of a server group role. CloudErrorBody: description: An error response from the service. type: object properties: code: description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. type: string message: description: A message describing the error, intended to be suitable for display in a user interface. type: string details: description: A list of additional details about the error. type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-identifiers: [] x-ms-external: true Role_5: properties: systemData: description: The system metadata relating to this resource $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData properties: $ref: '#/definitions/RoleProperties_2' x-ms-client-flatten: true description: The properties of a role. allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource description: Represents a server group role. RoleListResult_2: description: The response of list role assignment operation. properties: value: type: array items: $ref: '#/definitions/RoleResourceFormat' description: Results of the list operation. nextLink: type: string description: Link to the next set of results. ARMBaseModel: description: Represents the base class for all object models. type: object properties: id: description: The path ID that uniquely identifies the object. type: string readOnly: true name: description: The object name. type: string readOnly: true type: description: The hierarchical type of the object. type: string readOnly: true x-ms-azure-resource: true Role_3: description: The Role definition. properties: roleName: type: string description: The role name. description: type: string description: The description of the role. CloudErrorBody_2: x-ms-external: true description: An error response from the Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for display in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array description: A list of additional details about the error. items: $ref: '#/definitions/CloudErrorBody_2' x-ms-identifiers: - code RoleList: description: Collection of all the roles on the Data Box Edge device. type: object properties: value: description: The Value. uniqueItems: false type: array items: $ref: '#/definitions/Role_4' readOnly: true x-ms-identifiers: [] nextLink: description: Link to the next set of results. type: string readOnly: true Error: description: The response error definition. type: object properties: error: description: Error details for current request. $ref: '#/definitions/ErrorDetails' required: - error RoleCollection: description: The paged results of roles. type: object properties: value: description: The collection of roles. type: array items: $ref: '#/definitions/Role_2' nextLink: description: URL to get the next page of roles. type: string required: - value Role_4: description: Compute role. required: - kind type: object allOf: - $ref: '#/definitions/ARMBaseModel' properties: kind: description: Role type. enum: - IOT - ASA - Functions - Cognitive - MEC - CloudEdgeManagement - Kubernetes type: string x-ms-enum: name: RoleTypes modelAsString: true systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: Metadata pertaining to creation and last modification of Role readOnly: true discriminator: kind Role: description: Represents a cluster role. type: object allOf: - $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/RoleProperties' x-ms-client-flatten: true description: The properties of a role. required: - properties CloudError: description: An error response from the service. type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: The error details. x-ms-external: true ProvisioningState: type: string readOnly: true description: The current provisioning state. enum: - Succeeded - Canceled - InProgress - Failed x-ms-enum: name: ProvisioningState modelAsString: true Role_2: description: The role definition. type: object properties: id: description: Unique ID of the role. type: string readOnly: true displayName: description: Display name of the role. type: string CloudError_2: x-ms-external: true description: An error response from the Batch service. properties: error: $ref: '#/definitions/CloudErrorBody_2' description: The error. parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. ServerGroupNameParameter: name: serverGroupName in: path required: true type: string description: The name of the server group. minLength: 1 maxLength: 90 x-ms-parameter-location: method resourceGroupNameParameter: name: resourceGroupName in: path description: The resource group name. required: true type: string x-ms-parameter-location: method RoleNameParameter: name: roleName in: path required: true type: string description: The name of the cluster role. pattern: ^[-\w\._]+$ x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. apiVersionParameter: name: api-version in: query description: The API version. required: true type: string ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?