swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MasterSitesController API
schemes:
- https
tags:
- name: MasterSitesController
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites:
    get:
      operationId: microsoftAzureMastersitescontrollerListbysubscription
      tags:
      - MasterSitesController
      summary: Microsoft Azure Get All The Sites In The Subscription
      description: List MasterSite resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/MasterSiteListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        MasterSitesController_ListBySubscription_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites:
    get:
      operationId: microsoftAzureMastersitescontrollerListbyresourcegroup
      tags:
      - MasterSitesController
      summary: Microsoft Azure Get All Sites
      description: Get all the sites in the resource group.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/MasterSiteListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        MasterSitesController_ListByResourceGroup_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}:
    get:
      operationId: microsoftAzureMastersitescontrollerGet
      tags:
      - MasterSitesController
      summary: Microsoft Azure Method To Get A Master Site
      description: Get a MasterSite
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/MasterSite'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MasterSitesController_Get_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_Get_MaximumSet_Gen.json
    put:
      operationId: microsoftAzureMastersitescontrollerCreate
      tags:
      - MasterSitesController
      description: Method to create or update a site.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: body
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/MasterSite'
      responses:
        '200':
          description: ARM update operation completed successfully.
          schema:
            $ref: '#/definitions/MasterSite'
        '201':
          description: ARM create operation completed successfully.
          schema:
            $ref: '#/definitions/MasterSite'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      x-ms-examples:
        MasterSitesController_Create_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_Create_MaximumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename
    patch:
      operationId: microsoftAzureMastersitescontrollerUpdate
      tags:
      - MasterSitesController
      description: Method to update an existing site.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/MasterSiteUpdate'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/MasterSite'
        '202':
          description: Resource update request accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      x-ms-examples:
        MasterSitesController_Update_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename
    delete:
      operationId: microsoftAzureMastersitescontrollerDelete
      tags:
      - MasterSitesController
      description: Method to delete a site.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MasterSitesController_Delete_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_Delete_MaximumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/errorSummary
  : post:
      operationId: microsoftAzureMastersitescontrollerErrorsummary
      tags:
      - MasterSitesController
      description: Method to get error summary from master site for an appliance.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: body
        in: body
        description: The content of the action request
        required: true
        schema:
          $ref: '#/definitions/ErrorSummaryRequest'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SiteErrorSummary'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MasterSitesController_ErrorSummary_MaximumSet_Gen:
          $ref: ./examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Errorsummary
definitions:
  PrivateLinkServiceConnectionState:
    type: object
    description: Service Connection State
    properties:
      status:
        $ref: '#/definitions/PrivateLinkServiceConnectionStateStatus'
        description: state status
      description:
        type: string
        description: description string
      actionsRequired:
        type: string
        description: actions required
  MasterSiteUpdateProperties:
    type: object
    description: The updatable properties of the MasterSite.
    properties:
      publicNetworkAccess:
        $ref: '#/definitions/MasterSitePropertiesPublicNetworkAccess'
        description: Gets or sets the state of public network access.
      allowMultipleSites:
        type: boolean
        description: 'Gets or sets a value indicating whether multiple sites per site type are

          allowed.'
      sites:
        type: array
        description: "Gets or sets the sites that are a part of Master Site.\n            The key\nshould contain the Site ARM name."
        items:
          type: string
      customerStorageAccountArmId:
        type: string
        description: Gets or sets a value for customer storage account ARM id.
  MasterSiteProperties:
    type: object
    description: Class for site properties.
    properties:
      publicNetworkAccess:
        $ref: '#/definitions/MasterSitePropertiesPublicNetworkAccess'
        description: Gets or sets the state of public network access.
      allowMultipleSites:
        type: boolean
        description: 'Gets or sets a value indicating whether multiple sites per site type are

          allowed.'
      sites:
        type: array
        description: "Gets or sets the sites that are a part of Master Site.\n            The key\nshould contain the Site ARM name."
        items:
          type: string
      customerStorageAccountArmId:
        type: string
        description: Gets or sets a value for customer storage account ARM id.
      privateEndpointConnections:
        type: array
        description: Gets the private endpoint connections.
        items:
          $ref: '#/definitions/PrivateEndpointConnection'
        readOnly: true
      nestedSites:
        type: array
        description: Gets the nested sites under Master Site.
        items:
          type: string
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: provisioning state enum
        readOnly: true
  MasterSitePropertiesPublicNetworkAccess:
    type: string
    description: PublicNetworkAccess
    enum:
    - NotSpecified
    - Enabled
    - Disabled
    x-ms-enum:
      name: MasterSitePropertiesPublicNetworkAccess
      modelAsString: true
      values:
      - name: NotSpecified
        value: NotSpecified
        description: NotSpecified value.
      - name: Enabled
        value: Enabled
        description: Enabled value.
      - name: Disabled
        value: Disabled
        description: Disabled value.
  ResourceId:
    type: object
    description: PrivateEndpointModelsResourceId
    properties:
      id:
        type: string
        description: id name
        readOnly: true
  PrivateEndpointConnection:
    type: object
    description: REST model used to encapsulate Private Link properties for tracked resources.
    properties:
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionPropertiesV2'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  MasterSiteListResult:
    type: object
    description: The response of a MasterSite list operation.
    properties:
      value:
        type: array
        description: The MasterSite items on this page
        items:
          $ref: '#/definitions/MasterSite'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ProvisioningState:
    type: string
    description: The status of the current operation.
    enum:
    - Created
    - Updated
    - Running
    - Completed
    - Failed
    - Succeeded
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Created
        value: Created
        description: Created value.
      - name: Updated
        value: Updated
        description: Updated value.
      - name: Running
        value: Running
        description: Running value.
      - name: Completed
        value: Completed
        description: Completed value.
      - name: Failed
        value: Failed
        description: Failed value.
      - name: Succeeded
        value: Succeeded
        description: Succeeded value.
      - name: Canceled
        value: Canceled
        description: Canceled value.
  DiscoveryScopeErrorSummary:
    type: object
    description: The site error summary model.
    properties:
      affectedResourceType:
        type: string
        description: Gets or sets the affected resource type.
      affectedObjectsCount:
        type: integer
        format: int64
        description: Count of affected objects.
      discoveryScope:
        $ref: '#/definitions/DiscoveryScopes'
        description: Gets or sets the count of affected objects.
    required:
    - affectedResourceType
    - affectedObjectsCount
    - discoveryScope
  MasterSite:
    type: object
    description: A MasterSite
    properties:
      properties:
        $ref: '#/definitions/MasterSiteProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  ErrorSummaryRequest:
    type: object
    description: ErrorSummaryRequest body
    properties:
      applianceName:
        type: string
        description: Gets or sets the Appliance Name.
  SiteErrorSummary:
    type: object
    description: Site error summary.
    properties:
      applianceName:
        type: string
        description: Appliance Name.
      discoveryScopeErrorSummaries:
        $ref: '#/definitions/DiscoveryScopeErrorSummary'
        description: Gets the error message.
      nextLink:
        type: string
        description: The link to fetch more models.
    required:
    - applianceName
    - discoveryScopeErrorSummaries
  MasterSiteUpdate:
    type: object
    description: The type used for update operations of the MasterSite.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/MasterSiteUpdateProperties'
        x-ms-client-flatten: true
  PrivateLinkServiceConnectionStateStatus:
    type: string
    description: PrivateLinkServiceConnectionState
    enum:
    - Approved
    - Pending
    - Rejected
    - Disconnected
    x-ms-enum:
      name: PrivateLinkServiceConnectionStateStatus
      modelAsString: true
      values:
      - name: Approved
        value: Approved
        description: Approved value.
      - name: Pending
        value: Pending
        description: Pending value.
      - name: Rejected
        value: Rejected
        description: Rejected value.
      - name: Disconnected
        value: Disconnected
        description: Disconnected value.
  DiscoveryScopes:
    type: string
    description: Discovery scopes
    enum:
    - AppsAndRoles
    - DependencyMap
    - StaticData
    - SQLServerConnectionInfo
    x-ms-enum:
      name: DiscoveryScopes
      modelAsString: true
      values:
      - name: AppsAndRoles
        value: AppsAndRoles
        description: AppsAndRoles value.
      - name: DependencyMap
        value: DependencyMap
        description: DependencyMap value.
      - name: StaticData
        value: StaticData
        description: StaticData value.
      - name: SQLServerConnectionInfo
        value: SQLServerConnectionInfo
        description: SQLServerConnectionInfo value.
  PrivateEndpointConnectionPropertiesV2:
    type: object
    description: PrivateEndpointConnectionProperties V2
    properties:
      groupIds:
        type: array
        description: array of group ids
        items:
          type: string
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: provisioning state enum
        readOnly: true
      privateEndpoint:
        $ref: '#/definitions/ResourceId'
        description: private endpoints
        readOnly: true
      privateLinkServiceConnectionState:
        $ref: '#/definitions/PrivateLinkServiceConnectionState'
        description: private endpoints connection state
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'