Microsoft Azure RegistrationDefinitions API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RegistrationDefinitions API
schemes:
- https
tags:
- name: RegistrationDefinitions
paths:
  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}:
    get:
      tags:
      - RegistrationDefinitions
      operationId: microsoftAzureRegistrationdefinitionsGet
      description: Gets the registration definition details.
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/registrationDefinitionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - Returns the complete registration definition with plan details.
          schema:
            $ref: '#/definitions/RegistrationDefinition'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get Registration Definition:
          $ref: ./examples/GetRegistrationDefinition.json
      summary: Microsoft Azure Get Scope Providers Microsoft Managedservices Registrationdefinitions Registrationdefinitionid
    delete:
      tags:
      - RegistrationDefinitions
      operationId: microsoftAzureRegistrationdefinitionsDelete
      description: Deletes the registration definition.
      parameters:
      - $ref: '#/parameters/registrationDefinitionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      responses:
        '200':
          description: OK - The registration definition is deleted.
        '204':
          description: No Content- The registration definition does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete Registration Definition:
          $ref: ./examples/DeleteRegistrationDefinition.json
      summary: Microsoft Azure Delete Scope Providers Microsoft Managedservices Registrationdefinitions Registrationdefinitionid
    put:
      tags:
      - RegistrationDefinitions
      operationId: microsoftAzureRegistrationdefinitionsCreateorupdate
      x-ms-long-running-operation: true
      description: Creates or updates a registration definition.
      parameters:
      - $ref: '#/parameters/registrationDefinitionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - name: requestBody
        in: body
        required: true
        description: The parameters required to create new registration definition.
        schema:
          $ref: '#/definitions/RegistrationDefinition'
      responses:
        '200':
          description: Ok - Returns information about the updated registration definition.
          schema:
            $ref: '#/definitions/RegistrationDefinition'
        '201':
          description: Created - Returns information about the created registration definition.
          schema:
            $ref: '#/definitions/RegistrationDefinition'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Put Registration Definition:
          $ref: ./examples/PutRegistrationDefinition.json
      summary: Microsoft Azure Put Scope Providers Microsoft Managedservices Registrationdefinitions Registrationdefinitionid
  /{scope}/providers/Microsoft.ManagedServices/registrationDefinitions:
    get:
      tags:
      - RegistrationDefinitions
      operationId: microsoftAzureRegistrationdefinitionsList
      description: Gets a list of the registration definitions.
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - Returns a list of the registration definitions.
          schema:
            $ref: '#/definitions/RegistrationDefinitionList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get Registration Definitions:
          $ref: ./examples/GetRegistrationDefinitions.json
      summary: Microsoft Azure Get Scope Providers Microsoft Managedservices Registrationdefinitions
definitions:
  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.
  ErrorResponse:
    description: Error response.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
        type: object
  RegistrationDefinition:
    properties:
      properties:
        description: Properties of a registration definition.
        $ref: '#/definitions/RegistrationDefinitionProperties'
      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.
      name:
        readOnly: true
        type: string
        description: Name of the registration definition.
    x-ms-azure-resource: true
    type: object
    description: Registration definition.
  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.
  RegistrationDefinitionList:
    properties:
      value:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/RegistrationDefinition'
        description: List of registration definitions.
      nextLink:
        description: Link to next page of registration definitions.
        type: string
        readOnly: true
    description: List of registration definitions.
  RegistrationDefinitionProperties:
    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.
      managedByTenantId:
        type: string
        description: Id of the managedBy tenant.
      provisioningState:
        type: string
        readOnly: true
        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
      managedByTenantName:
        readOnly: true
        type: string
        description: Name of the managedBy tenant.
    required:
    - managedByTenantId
    - authorizations
    type: object
    description: Properties of a registration definition.
parameters:
  registrationDefinitionIdParameter:
    name: registrationDefinitionId
    in: path
    required: true
    x-ms-parameter-location: method
    type: string
    description: Guid of the registration definition.
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    x-ms-parameter-location: method
    type: string
    description: The API version to use for this operation.
  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.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'