Microsoft Azure RegistrationAssignments API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RegistrationAssignments API
schemes:
- https
tags:
- name: RegistrationAssignments
paths:
  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}:
    get:
      tags:
      - RegistrationAssignments
      operationId: microsoftAzureRegistrationassignmentsGet
      description: Gets the details of specified registration assignment.
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/RegistrationAssignmentIdParameter'
      - $ref: '#/parameters/ExpandRegistrationDefinition'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - Returns the registration assignment.
          schema:
            $ref: '#/definitions/RegistrationAssignment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get Registration Assignment:
          $ref: ./examples/GetRegistrationAssignment.json
      summary: Microsoft Azure Get Scope Providers Microsoft Managedservices Registrationassignments Registrationassignmentid
    delete:
      tags:
      - RegistrationAssignments
      operationId: microsoftAzureRegistrationassignmentsDelete
      x-ms-long-running-operation: true
      description: Deletes the specified registration assignment.
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/RegistrationAssignmentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - The registration assignment is deleted.
        '202':
          description: Accepted - The registration assignment deletion operation is accepted.
        '204':
          description: No Content- The registration assignment does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete Registration Assignment:
          $ref: ./examples/DeleteRegistrationAssignment.json
      summary: Microsoft Azure Delete Scope Providers Microsoft Managedservices Registrationassignments Registrationassignmentid
    put:
      tags:
      - RegistrationAssignments
      operationId: microsoftAzureRegistrationassignmentsCreateorupdate
      x-ms-long-running-operation: true
      description: Creates or updates a registration assignment.
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/RegistrationAssignmentIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: requestBody
        in: body
        required: true
        description: The parameters required to create new registration assignment.
        schema:
          $ref: '#/definitions/RegistrationAssignment'
      responses:
        '200':
          description: Ok - Returns information about the updated registration assignment.
          schema:
            $ref: '#/definitions/RegistrationAssignment'
        '201':
          description: Created - Returns information about the created registration assignment.
          schema:
            $ref: '#/definitions/RegistrationAssignment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Put Registration Assignment:
          $ref: ./examples/PutRegistrationAssignment.json
      summary: Microsoft Azure Put Scope Providers Microsoft Managedservices Registrationassignments Registrationassignmentid
  /{scope}/providers/Microsoft.ManagedServices/registrationAssignments:
    get:
      tags:
      - RegistrationAssignments
      operationId: microsoftAzureRegistrationassignmentsList
      description: Gets a list of the registration assignments.
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/ExpandRegistrationDefinition'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - Returns a list of the registration assignments.
          schema:
            $ref: '#/definitions/RegistrationAssignmentList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get Registration Assignments:
          $ref: ./examples/GetRegistrationAssignments.json
      summary: Microsoft Azure Get Scope Providers Microsoft Managedservices Registrationassignments
definitions:
  ErrorResponse:
    description: Error response.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
        type: object
  ErrorDefinition:
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message indicating why the operation failed.
      details:
        description: Internal error details.
        type: array
        items:
          $ref: '#/definitions/ErrorDefinition'
    required:
    - code
    - message
    type: object
    description: Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.
  RegistrationAssignment:
    properties:
      properties:
        description: Properties of a registration assignment.
        $ref: '#/definitions/RegistrationAssignmentProperties'
      id:
        readOnly: true
        type: string
        description: The fully qualified path of the registration assignment.
      type:
        readOnly: true
        type: string
        description: Type of the resource.
      name:
        readOnly: true
        type: string
        description: Name of the registration assignment.
    x-ms-azure-resource: true
    type: object
    description: Registration assignment.
  Authorization:
    properties:
      principalId:
        type: string
        description: Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription
      principalIdDisplayName:
        type: string
        description: Display name of the principal Id.
      roleDefinitionId:
        type: string
        description: The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role.
      delegatedRoleDefinitionIds:
        type: array
        description: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users.
        items:
          format: uuid
          type: string
    required:
    - principalId
    - roleDefinitionId
    type: object
    description: Authorization tuple containing principal Id (of user/service principal/security group) and role definition id.
  Plan:
    properties:
      name:
        type: string
        description: The plan name.
      publisher:
        type: string
        description: The publisher ID.
      product:
        type: string
        description: The product code.
      version:
        type: string
        description: The plan's version.
    required:
    - name
    - publisher
    - product
    - version
    type: object
    description: Plan details for the managed services.
  RegistrationAssignmentList:
    properties:
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/RegistrationAssignment'
        description: List of registration assignments.
      nextLink:
        description: Link to next page of registration assignments.
        type: string
        readOnly: true
    description: List of registration assignments.
  RegistrationAssignmentProperties:
    properties:
      registrationDefinitionId:
        type: string
        description: Fully qualified path of the registration definition.
      provisioningState:
        readOnly: true
        type: string
        description: Current state of the registration assignment.
        enum:
        - NotSpecified
        - Accepted
        - Running
        - Ready
        - Creating
        - Created
        - Deleting
        - Deleted
        - Canceled
        - Failed
        - Succeeded
        - Updating
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      registrationDefinition:
        readOnly: true
        properties:
          properties:
            properties:
              description:
                type: string
                description: Description of the registration definition.
              authorizations:
                type: array
                items:
                  $ref: '#/definitions/Authorization'
                description: Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role.
              registrationDefinitionName:
                type: string
                description: Name of the registration definition.
              provisioningState:
                type: string
                description: Current state of the registration definition.
                enum:
                - NotSpecified
                - Accepted
                - Running
                - Ready
                - Creating
                - Created
                - Deleting
                - Deleted
                - Canceled
                - Failed
                - Succeeded
                - Updating
                x-ms-enum:
                  name: ProvisioningState
                  modelAsString: true
              manageeTenantId:
                type: string
                description: Id of the home tenant.
              manageeTenantName:
                type: string
                description: Name of the home tenant.
              managedByTenantId:
                type: string
                description: Id of the managedBy tenant.
              managedByTenantName:
                type: string
                description: Name of the managedBy tenant.
            description: Properties of registration definition inside registration assignment.
          plan:
            description: Plan details for the managed services.
            $ref: '#/definitions/Plan'
          id:
            readOnly: true
            type: string
            description: Fully qualified path of the registration definition.
          type:
            readOnly: true
            type: string
            description: Type of the resource (Microsoft.ManagedServices/registrationDefinitions).
          name:
            readOnly: true
            type: string
            description: Name of the registration definition.
        type: object
        description: Registration definition inside registration assignment.
    required:
    - registrationDefinitionId
    type: object
    description: Properties of a registration assignment.
parameters:
  ScopeParameter:
    name: scope
    in: path
    required: true
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    description: Scope of the resource.
  RegistrationAssignmentIdParameter:
    name: registrationAssignmentId
    in: path
    required: true
    x-ms-parameter-location: method
    type: string
    description: Guid of the registration assignment.
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    x-ms-parameter-location: method
    type: string
    description: The API version to use for this operation.
  ExpandRegistrationDefinition:
    name: $expandRegistrationDefinition
    in: query
    x-ms-parameter-location: method
    type: boolean
    description: Tells whether to return registration definition details also along with registration assignment details.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'