swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ProviderRegistration API
schemes:
- https
tags:
- name: ProviderRegistration
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}:
    get:
      tags:
      - ProviderRegistration
      description: Gets the provider registration details.
      operationId: microsoftAzureProviderregistrationsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        ProviderRegistrations_Get:
          $ref: ./examples/ProviderRegistrations_Get.json
      responses:
        '200':
          description: Successfully retrieved the provider registration.
          schema:
            $ref: '#/definitions/ProviderRegistration'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace
    put:
      tags:
      - ProviderRegistration
      description: Creates or updates the provider registration.
      operationId: microsoftAzureProviderregistrationsCreateorupdate
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - name: properties
        in: body
        required: true
        schema:
          $ref: '#/definitions/ProviderRegistration'
        description: The provider registration properties supplied to the CreateOrUpdate operation.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        ProviderRegistrations_CreateOrUpdate:
          $ref: ./examples/ProviderRegistrations_CreateOrUpdate.json
      responses:
        '200':
          description: Successfully updated the provider registration.
          schema:
            $ref: '#/definitions/ProviderRegistration'
        '201':
          description: Successfully created the provider registration.
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace
    delete:
      tags:
      - ProviderRegistration
      description: Deletes a provider registration.
      operationId: microsoftAzureProviderregistrationsDelete
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        ProviderRegistrations_Delete:
          $ref: ./examples/ProviderRegistrations_Delete.json
      responses:
        '200':
          description: Successfully deleted the provider registration.
        '204':
          description: Resource does not exist.
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace
  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations:
    get:
      tags:
      - ProviderRegistration
      description: Gets the list of the provider registrations in the subscription.
      operationId: microsoftAzureProviderregistrationsList
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        ProviderRegistrations_List:
          $ref: ./examples/ProviderRegistrations_List.json
      responses:
        '200':
          description: Successfully retrieved the provider registrations.
          schema:
            $ref: '#/definitions/ProviderRegistrationArrayResponseWithContinuation'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations
  ? /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/generateOperations
  : post:
      tags:
      - ProviderRegistration
      description: Generates the operations api for the given provider.
      operationId: microsoftAzureProviderregistrationsGenerateoperations
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        ProviderRegistrations_GenerateOperations:
          $ref: ./examples/ProviderRegistrations_GenerateOperations.json
      responses:
        '200':
          description: The operations api has been generated successfully.
          schema:
            type: array
            items:
              $ref: '#/definitions/OperationsDefinition'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Generateoperations
definitions:
  SubscriptionStateOverrideAction:
    required:
    - action
    - state
    type: object
    properties:
      state:
        enum:
        - Registered
        - Unregistered
        - Warned
        - Suspended
        - Deleted
        - WarnedToRegistered
        - WarnedToSuspended
        - WarnedToDeleted
        - WarnedToUnregistered
        - SuspendedToRegistered
        - SuspendedToWarned
        - SuspendedToDeleted
        - SuspendedToUnregistered
        type: string
        x-ms-enum:
          name: SubscriptionTransitioningState
          modelAsString: true
      action:
        enum:
        - NotDefined
        - DeleteAllResources
        - SoftDeleteAllResources
        - NoOp
        - BillingCancellation
        - UndoSoftDelete
        type: string
        x-ms-enum:
          name: SubscriptionNotificationOperation
          modelAsString: true
  OperationsDisplayDefinition:
    required:
    - description
    - operation
    - provider
    - resource
    type: object
    properties:
      provider:
        type: string
      resource:
        type: string
      operation:
        type: string
      description:
        type: string
  ProviderRegistration:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      properties:
        allOf:
        - $ref: '#/definitions/ProviderRegistrationProperties'
      systemData:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
        readOnly: true
    x-ms-azure-resource: true
  ResourceProviderCapabilities:
    required:
    - effect
    - quotaId
    type: object
    properties:
      quotaId:
        type: string
      effect:
        enum:
        - NotSpecified
        - Allow
        - Disallow
        type: string
        x-ms-enum:
          name: ResourceProviderCapabilitiesEffect
          modelAsString: true
      requiredFeatures:
        type: array
        items:
          type: string
  ResourceProviderManifestProperties:
    type: object
    properties:
      providerAuthentication:
        allOf:
        - $ref: '#/definitions/ResourceProviderAuthentication'
      providerAuthorizations:
        type: array
        items:
          $ref: '#/definitions/ResourceProviderAuthorization'
      namespace:
        type: string
      providerVersion:
        type: string
      providerType:
        enum:
        - NotSpecified
        - Internal
        - External
        - Hidden
        - RegistrationFree
        - LegacyRegistrationRequired
        - TenantOnly
        - AuthorizationFree
        type: string
        x-ms-enum:
          name: ResourceProviderType
          modelAsString: true
      requiredFeatures:
        type: array
        items:
          type: string
      featuresRule:
        allOf:
        - $ref: '#/definitions/FeaturesRule'
      requestHeaderOptions:
        allOf:
        - $ref: '#/definitions/RequestHeaderOptions'
      management:
        allOf:
        - $ref: '#/definitions/ResourceProviderManagement'
      capabilities:
        type: array
        items:
          $ref: '#/definitions/ResourceProviderCapabilities'
      metadata: {}
      templateDeploymentOptions:
        allOf:
        - $ref: '#/definitions/TemplateDeploymentOptions'
  LightHouseAuthorization:
    required:
    - principalId
    - roleDefinitionId
    type: object
    properties:
      principalId:
        type: string
      roleDefinitionId:
        type: string
  ProviderHubMetadata:
    type: object
    properties:
      providerAuthorizations:
        type: array
        items:
          $ref: '#/definitions/ResourceProviderAuthorization'
      providerAuthentication:
        allOf:
        - $ref: '#/definitions/ResourceProviderAuthentication'
      thirdPartyProviderAuthorization:
        allOf:
        - $ref: '#/definitions/ThirdPartyProviderAuthorization'
  RequestHeaderOptions:
    type: object
    properties:
      optInHeaders:
        enum:
        - NotSpecified
        - SignedUserToken
        - ClientGroupMembership
        - SignedAuxiliaryTokens
        - UnboundedClientGroupMembership
        type: string
        x-ms-enum:
          name: OptInHeaderType
          modelAsString: true
  ResourceProviderAuthentication:
    required:
    - allowedAudiences
    type: object
    properties:
      allowedAudiences:
        type: array
        items:
          type: string
  FeaturesRule:
    required:
    - requiredFeaturesPolicy
    type: object
    properties:
      requiredFeaturesPolicy:
        enum:
        - Any
        - All
        type: string
        x-ms-enum:
          name: FeaturesPolicy
          modelAsString: true
  ProviderRegistrationProperties:
    type: object
    allOf:
    - $ref: '#/definitions/ResourceProviderManifestProperties'
    properties:
      providerHubMetadata:
        allOf:
        - $ref: '#/definitions/ProviderHubMetadata'
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The provisioned state of the resource.
      subscriptionLifecycleNotificationSpecifications:
        allOf:
        - $ref: '#/definitions/SubscriptionLifecycleNotificationSpecifications'
  ServiceTreeInfo:
    type: object
    properties:
      serviceId:
        type: string
      componentId:
        type: string
      readiness:
        enum:
        - ClosingDown
        - Deprecated
        - GA
        - InDevelopment
        - InternalOnly
        - PrivatePreview
        - PublicPreview
        - RemovedFromARM
        - Retired
        type: string
        x-ms-enum:
          name: Readiness
          modelAsString: true
  ThirdPartyProviderAuthorization:
    type: object
    properties:
      authorizations:
        type: array
        items:
          $ref: '#/definitions/LightHouseAuthorization'
      managedByTenantId:
        type: string
  OperationsDefinition:
    required:
    - display
    - name
    type: object
    properties:
      name:
        type: string
        description: Name of the operation.
      isDataAction:
        type: boolean
        description: Indicates whether the operation applies to data-plane.
      origin:
        enum:
        - NotSpecified
        - User
        - System
        type: string
      display:
        description: Display information of the operation.
        allOf:
        - $ref: '#/definitions/OperationsDisplayDefinition'
      actionType:
        enum:
        - NotSpecified
        - Internal
        type: string
      properties: {}
    description: Properties of an Operation.
  ProviderRegistrationArrayResponseWithContinuation:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ProviderRegistration'
      nextLink:
        description: The URL to get to the next set of results, if there are any.
        type: string
  Error:
    description: Standard error object.
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        type: string
        readOnly: true
      message:
        description: Human-readable representation of the error.
        type: string
        readOnly: true
      target:
        description: Target of the error.
        type: string
        readOnly: true
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
        readOnly: true
      innerError:
        description: Object containing more specific information than  the current object about the error.
        allOf:
        - $ref: '#/definitions/InnerError'
        readOnly: true
  SubscriptionLifecycleNotificationSpecifications:
    type: object
    properties:
      subscriptionStateOverrideActions:
        type: array
        items:
          $ref: '#/definitions/SubscriptionStateOverrideAction'
      softDeleteTTL:
        format: duration
        type: string
  ErrorResponse:
    description: Standard error response.
    type: object
    properties:
      error:
        description: Standard error object.
        allOf:
        - $ref: '#/definitions/Error'
  ResourceProviderAuthorization:
    type: object
    properties:
      applicationId:
        type: string
      roleDefinitionId:
        type: string
      managedByRoleDefinitionId:
        type: string
  ProvisioningState:
    enum:
    - NotSpecified
    - Accepted
    - Running
    - Creating
    - Created
    - Deleting
    - Deleted
    - Canceled
    - Failed
    - Succeeded
    - MovingResources
    - TransientFailure
    - RolloutInProgress
    type: string
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  TemplateDeploymentOptions:
    type: object
    properties:
      preflightSupported:
        type: boolean
      preflightOptions:
        type: array
        items:
          enum:
          - None
          - ContinueDeploymentOnFailure
          - DefaultValidationOnly
          type: string
          x-ms-enum:
            name: PreflightOption
            modelAsString: true
  InnerError:
    description: Inner error containing list of errors.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
        readOnly: true
      innerError:
        description: Object containing more specific information than the current object about the error.
        type: object
        readOnly: true
    additionalProperties:
      type: object
  ResourceProviderManagement:
    type: object
    properties:
      schemaOwners:
        type: array
        items:
          type: string
      manifestOwners:
        type: array
        items:
          type: string
      incidentRoutingService:
        type: string
      incidentRoutingTeam:
        type: string
      incidentContactEmail:
        type: string
      serviceTreeInfos:
        type: array
        items:
          $ref: '#/definitions/ServiceTreeInfo'
      resourceAccessPolicy:
        enum:
        - NotSpecified
        - AcisReadAllowed
        - AcisActionAllowed
        type: string
      resourceAccessRoles:
        type: array
        items: {}
parameters:
  ProviderNamespaceParameter:
    in: path
    name: providerNamespace
    description: The name of the resource provider hosted within ProviderHub.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'