swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Account API
schemes:
- https
tags:
- name: Account
paths:
  /:
    get:
      tags:
      - Account
      description: Get an account
      operationId: microsoftAzureAccountsGetaccountproperties
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Accounts_GetAccountProperties:
          $ref: ./examples/Accounts_GetAccountProperties.json
      summary: Microsoft Azure Get
    patch:
      tags:
      - Account
      description: Updates an account
      operationId: microsoftAzureAccountsUpdateaccountproperties
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DataPlaneAccountUpdateParameters'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Accounts_UpdateAccountProperties:
          $ref: ./examples/Accounts_UpdateAccountProperties.json
      summary: Microsoft Azure Patch
  /listkeys:
    post:
      tags:
      - Account
      description: Lists the connection strings that allow connecting with the Managed Event Hub, if it is provisioned. Those connection strings are aimed to receive messages from the ATLAS_ENTITIES hub or to send messages to the ATLAS_HOOK hub.
      operationId: microsoftAzureAccountsGetaccesskeys
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccessKeys'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Accounts_GetAccessKeys:
          $ref: ./examples/Accounts_GetAccessKeys.json
      summary: Microsoft Azure Post Listkeys
  /regeneratekeys:
    post:
      tags:
      - Account
      description: Regenerates either the primary or secondary key of the Managed Event Hub, if it is provisioned.
      operationId: microsoftAzureAccountsRegenerateaccesskeys
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/AccessKeyOptions'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccessKeys'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Accounts_RegenerateAccessKeys:
          $ref: ./examples/Accounts_RegenerateAccessKeys.json
      summary: Microsoft Azure Post Regeneratekeys
  /subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts:
    get:
      tags:
      - Account
      summary: Microsoft Azure List Accounts In A Subscription
      description: List Accounts in Subscription
      operationId: microsoftAzureAccountsListbysubscription
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/api-version_2'
      - name: $skipToken
        in: query
        description: Continuation token
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Accounts_ListBySubscription:
          $ref: ./examples/Accounts_ListBySubscription.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}:
    get:
      tags:
      - Account
      summary: Microsoft Azure Get An Account Under A Resource Group
      description: Get an account
      operationId: microsoftAzureAccountsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account_2'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        Accounts_Get:
          $ref: ./examples/Accounts_Get.json
    put:
      tags:
      - Account
      summary: Microsoft Azure Create An Account In The Given Resource Group
      description: Create an account
      operationId: microsoftAzureAccountsCreate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: account
        in: body
        description: The account payload.
        required: true
        schema:
          $ref: '#/definitions/Account_2'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account_2'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Account_2'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Accounts_Create:
          $ref: ./examples/Accounts_Create.json
    delete:
      tags:
      - Account
      summary: Microsoft Azure Delete An Account
      description: DeleteAccount
      operationId: microsoftAzureAccountsDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OperationResponse'
        '202':
          description: Accepted
        '204':
          description: Success
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Accounts_Delete:
          $ref: ./examples/Accounts_Delete.json
    patch:
      tags:
      - Account
      summary: Microsoft Azure Patch A Given Account
      description: Patch an account
      operationId: microsoftAzureAccountsUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: accountUpdateParameters
        in: body
        description: The account update parameters.
        required: true
        schema:
          $ref: '#/definitions/AccountUpdateParameters'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account_2'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        Accounts_Update:
          $ref: ./examples/Accounts_Update.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts:
    get:
      tags:
      - Account
      summary: Microsoft Azure List Accounts In A Resource Group
      description: List Accounts in ResourceGroup
      operationId: microsoftAzureAccountsListbyresourcegroup
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/api-version_2'
      - name: $skipToken
        in: query
        description: Continuation token
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Accounts_ListByResourceGroup:
          $ref: ./examples/Accounts_ListByResourceGroup.json
  /accounts:
    get:
      operationId: microsoftAzureAccountsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - format: int32
        in: query
        name: maxpagesize
        type: integer
        description: Maximum number of records to include in a single response. Defaults to 200, and must not exceed 500.
      - format: int32
        in: query
        name: skip
        type: integer
        description: An offset into the collection of the first record to be returned.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountsList'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Account
      description: Gets a list of account records. An account represents a customer to which you are providing service. Response pagination can be controlled with a combination of the maxpagesize and skip parameters. Limit the number of records in a response with the maxpagesize parameter. Specify the starting record using the skip parameter.
      x-ms-examples:
        Get a list of account records.:
          $ref: ./examples/GetAccounts.json
      summary: Microsoft Azure Get Accounts
  /accounts/{accountName}:
    delete:
      operationId: microsoftAzureAccountDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: No Content
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete an account:
          $ref: ./examples/DeleteAccount.json
      tags:
      - Account
      description: Deletes an account (representing a customer).
      summary: Microsoft Azure Delete Accounts Accountname
    get:
      operationId: microsoftAzureAccountGet
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes. Can be up to 100 characters in length.
      - $ref: '#/parameters/ApiVersionParameter'
      - name: status
        in: query
        default: false
        required: false
        type: boolean
        description: Additionally return the provisioning state of the backends configured for this account (e.g. DNS subdomain provisioning for Microsoft Teams Direct Routing).
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountWithStatusResponse'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get information about an account:
          $ref: ./examples/GetAccount.json
      tags:
      - Account
      description: Gets the details of the specified account. An account represents a customer.
      summary: Microsoft Azure Get Accounts Accountname
    put:
      operationId: microsoftAzureAccountCreateorreplace
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
      - $ref: '#/parameters/ApiVersionParameter'
      - in: header
        name: If-Match
        type: string
        description: Makes a request conditional on a matching etag.
      - in: header
        name: If-None-Match
        type: string
        description: Makes a request conditional on a non-matching etag.
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/AccountDetails'
        description: New details of the account to create or replace.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountResponse'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/AccountResponse'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Put new information about an account:
          $ref: ./examples/PutAccount.json
      tags:
      - Account
      description: Creates or replaces the specified account, representing a customer. In the body of the request, include additional service-specific configuration. For example, for Microsoft Teams Direct Routing, specify the customer-specific subdomain label and DNS TXT values from the customer's Microsoft 365 configuration.
      summary: Microsoft Azure Put Accounts Accountname
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts:
    get:
      tags:
      - Account
      summary: Microsoft Azure Gets The Accounts Resources By Resource Group
      description: List accounts in ResourceGroup
      operationId: microsoftAzureAccountsListbyresourcegroup
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/api-version_3'
      - name: $skipToken
        in: query
        description: The skip token.
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountList_2'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Accounts_ListByResourceGroup:
          $ref: ./examples/Accounts_ListByResourceGroup.json
  /subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts:
    get:
      tags:
      - Account
      summary: Microsoft Azure Gets The Accounts Resources By Subscription
      description: List accounts in Subscription
      operationId: microsoftAzureAccountsListbysubscription
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/api-version_3'
      - name: $skipToken
        in: query
        description: The skip token.
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccountList_2'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Accounts_ListBySubscription:
          $ref: ./examples/Accounts_ListBySubscription.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}:
    get:
      tags:
      - Account
      summary: Microsoft Azure Gets The Account Resource
      description: Get an account
      operationId: microsoftAzureAccountsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName_2'
      - $ref: '#/parameters/api-version_3'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account_3'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-examples:
        Accounts_Get:
          $ref: ./examples/Accounts_Get.json
    put:
      tags:
      - Account
      summary: Microsoft Azure Create Or Update An Account Resource
      description: Creates or updates an account
      operationId: microsoftAzureAccountsCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName_2'
      - name: account
        in: body
        description: The account.
        required: true
        schema:
          $ref: '#/definitions/Account_3'
      - $ref: '#/parameters/api-version_3'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account_3'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Account_3'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        Accounts_CreateOrUpdate:
          $ref: ./examples/Accounts_CreateOrUpdate.json
    delete:
      tags:
      - Account
      summary: Microsoft Azure Deletes The Account Resource
      description: Deletes an account resource
      operationId: microsoftAzureAccountsDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName_2'
      - $ref: '#/parameters/api-version_3'
      responses:
        '200':
          description: Success
        '202':
          description: Accepted
        '204':
          description: Success
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        Accounts_Delete:
          $ref: ./examples/Accounts_Delete.json
    patch:
      tags:
      - Account
      summary: Microsoft Azure Patches The Account Resource
      description: Updates an account
      operationId: microsoftAzureAccountsUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName_2'
      - name: accountUpdateParameters
        in: body
        description: The account update parameters.
        required: true
        schema:
          $ref: '#/definitions/AccountUpdateParameters_2'
      - $ref: '#/parameters/api-version_3'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Account_3'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/Account_3'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        Accounts_Update:
          $ref: ./examples/Accounts_Update.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys
  : post:
      tags:
      - Account
      summary: Microsoft Azure Lists The Keys Asynchronous
      description: List the authorization keys associated with this account.
      operationId: microsoftAzureAccountsListkeys
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName_2'
      - $ref: '#/parameters/api-version_3'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AccessKeys'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-examples:
        Accounts_ListKeys:
          $ref: ./examples/Accounts_ListKeys.json
definitions:
  DataPlaneAccountUpdateParameters:
    description: The account properties that can be updated through data plane.
    type: object
    properties:
      friendlyName:
        description: The friendly name for the azure resource.
        type: string
  ProxyResource:
    description: Proxy Azure Resource
    type: object
    properties:
      id:
        description: Gets or sets the identifier.
        type: string
        readOnly: true
      name:
        description: Gets or sets the name.
        type: string
        readOnly: true
      type:
        description: Gets or sets the type.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  TeamsDrConfig:
    additionalProperties: false
    properties:
      callScreening:
        type: boolean
        description: Enables/disables caller ID screening for the account. Caller ID screening is enabled by default.
      subdomain:
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 10
        type: string
        description: Customer-specific domain name label. Can only contain letters, numbers, underscores and dashes. Can be up to 10 characters in length.
      subdomainTokens:
        $ref: '#/definitions/TeamsDrSubdomainTokens'
    required:
    - callScreening
    - subdomain
    - subdomainTokens
    type: object
    description: Account configuration relating to Microsoft Teams Direct Routing.
  ErrorDetail:
    title: The code and message for an error.
    type: object
    properties:
      code:
        description: A machine readable error code.
        type: string
      message:
        description: A human readable representation of the error.
        type: string
      details:
        description: An array of details about specific errors that led to this error.
        type: array
        items:
          $ref: '#/definitions/ErrorDetail'
      innererror:
        description: An object containing more specific information about the error.
        $ref: '#/definitions/InnerError'
      additionalProperties:
        description: Additional properties that can be provided about the error.
    required:
    - code
    - message
  PrivateEndpoint:
    description: A private endpoint class.
    type: object
    properties:
      id:
        description: The private endpoint identifier.
        type: string
  ErrorModel:
    description: Default error model
    type: object
    properties:
      code:
        description: Gets or sets the code.
        type: string
        readOnly: true
      details:
        description: Gets or sets the details.
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
        readOnly: true
      message:
        description: Gets or sets the messages.
        type: string
        readOnly: true
      target:
        description: Gets or sets the target.
        type: string
        readOnly: true
  AccountMergeInfo:
    description: The public Account Merge Info model.
    type: object
    properties:
      accountLocation:
        description: The account location of the *other* account in the merge operation.
        type: string
        readOnly: true
      accountName:
        description: The account name of the *other* account in the merge operation.
        type: string
        readOnly: true
      accountResourceGroupName:
        description: The resource group name of the *other* account in the merge operation.
        type: string
        readOnly: true
      accountSubscriptionId:
        description: The subscription id of the *other* account in the merge operation.
        type: string
        readOnly: true
      mergeStatus:
        description: The status of the merge operation.
        enum:
        - Succeeded
        - Failed
        - InProgress
        type: string
        readOnly: true
        x-ms-enum:
          name: MergeStatus
          modelAsString: true
      typeOfAccount:
        description: The type of account this account is for the merge operation.
        enum:
        - Primary
        - Secondary
        type: string
        readOnly: true
        x-ms-enum:
          name: MergeAccountType
          modelAsString: true
  AccountsList:
    additionalProperties: false
    properties:
      value:
        items:
          $ref: '#/definitions/AccountResponse'
        type: array
        description: List of account records.
      nextLink:
        type: string
        format: uri
        description: Link to the next page of results.
    required:
    - value
    type: object
    description: Paginated list of records for an account.
  TeamsDrSubdomainTokens:
    additionalProperties: false
    properties:
      region1Token:
        pattern: ^([A-Za-z0-9=_-]+)$
        minLength: 1
        maxLength: 100
        type: string
        description: DNS TXT value for the first region, as provided by the customer from their Microsoft 365 Admin Center. Can only contain letters, numbers, underscores and dashes. Can be up to 100 characters in length.
      region2Token:
        pattern: ^([A-Za-z0-9=_-]+)$
        minLength: 1
        maxLength: 100
        type: string
        description: DNS TXT value for the first region, as provided by the customer from their Microsoft 365 Admin Center. Can only contain letters, numbers, underscores and dashes. Can be up to 100 characters in length.
    required:
    - region1Token
    - region2Token
    type: object
    description: DNS TXT values (tokens) for the account.
  AccountProperties_2:
    description: Account property bag.
    type: object
    properties:
      createdAt:
        format: date-time
        description: Time at which the account was created.
        type: string
        readOnly: true
      provisioningState:
        description: Provisioning state of the Account
        enum:
        - Succeeded
        - Creating
        - Deleting
        - Moving
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: provisioningState
          modelAsString: true
      userEmail:
        description: Email of the user who created the resource
        type: string
        readOnly: true
      userName:
        description: Name of the user who created the resource
        type: string
        readOnly: true
  Account_3:
    description: Account resource
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/AccountProperties_3'
        description: Gets or sets the properties.
        x-ms-client-flatten: true
      sku:
        description: Gets or sets the Sku.
        allOf:
        - $ref: '#/definitions/AccountSku_2'
        readOnly: true
  Account:
    description: Account resource
    type: object
    properties:
      id:
        description: Gets or sets the identifier.
        type: string
        readOnly: true
      identity:
        $ref: '#/definitions/Identity'
      location:
        description: Gets or sets the location.
        type: string
      name:
        description: Gets or sets the name.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/AccountProperties'
      sku:
        $ref: '#/definitions/AccountSku'
      systemData:
        $ref: '#/definitions/SystemData'
      tags:
        description: Tags on the azure resource.
        type: object
        additionalProperties:
          type: string
      type:
        description: Gets or sets the type.
        type: string
        readOnly: true
  Identity_3:
    description: The Managed Identity of the resource
    type: object
    properties:
      principalId:
        description: Service principal object Id
        type: string
        readOnly: true
      tenantId:
        description: Tenant Id
        type: string
        readOnly: true
      type:
        description: Identity Type
        enum:
        - SystemAssigned
        type: string
        x-ms-enum:
          name: type
          modelAsString: true
  AccountStatus:
    description: The account status.
    type: object
    properties:
      accountProvisioningState:
        description: Gets the account status code.
        enum:
        - Unknown
        - Creating
        - Updating
        - Moving
        - Deleting
        - SoftDeleting
        - SoftDeleted
        - Failed
        - Succeeded
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: AccountProvisioningState
          modelAsString: true
      errorDetails:
        $ref: '#/definitions/ErrorModel'
  PrivateLinkServiceConnectionState:
    description: The private link service connection state.
    type: object
    properties:
      actionsRequired:
        description: The required actions.
        type: string
      description:
        description: The description.
        type: string
      status:
        description: The status.
        enum:
        - Unknown
        - Pending
        - Approved
        - Rejected
        - Disconnected
        type: string
        x-ms-enum:
          name: PrivateEndpointConnectionStatus
          modelAsString: true
  SystemData_2:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    properties:
      createdAt:
        format: date-time
        description: The timestamp of resource creation (UTC).
        type: string
        readOnly: true
      createdBy:
        description: The identity that created the resource.
        type: string
        readOnly: true
      createdByType:
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        readOnly: true
        x-ms-enum:
          name: createdByType
          modelAsString: true
      lastModifiedAt:
        format: date-time
        description: The timestamp of the last modification the resource (UTC).
        type: string
        readOnly: true
      lastModifiedBy:
        description: The identity that last modified the resource.
        type: string
        readOnly: true
      lastModifiedByType:
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        readOnly: true
        x-ms-enum:
          name: lastModifiedByType
          modelAsString: true
  AccountList:
    description: List response for get Accounts.
    required:
    - value
    type: object
    properties:
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type DataTransferObjects.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Account_2'
  PrivateEndpointConnectionProperties:
    description: A private endpoint connection properties class.
    type: object
    properties:
      privateEndpoint:
        $ref: '#/definitions/PrivateEndpoint'
      privateLinkServiceConnectionState:
        $ref: '#/definitions/PrivateLinkServiceConnectionState'
      provisioningState:
        description: The provisioning state.
        type: string
        readOnly: true
  TrackedResource:
    description: Azure ARM Tracked Resource
    type: object
    properties:
      id:
        description: Gets or sets the identifier.
        type: string
        readOnly: true
      identity:
        $ref: '#/definitions/Identity_3'
        description: Identity Info on the tracked resource
      location:
        description: Gets or sets the location.
        type: string
      name:
        description: Gets or sets the name.
        type: string
        readOnly: true
      tags:
        description: Tags on the azure resource.
        type: object
        additionalProperties:
          type: string
      type:
        description: Gets or sets the type.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  AccessKeys:
    description: The Account access keys.
    type: object
    properties:
      atlasKafkaPrimaryEndpoint:
        description: Gets or sets the primary connection string.
        type: string
      atlasKafkaSecondaryEndpoint:
        description: Gets or sets the secondary connection string.
        type: string
  AccountEndpoints_2:
    description: The account endpoints
    type: object
    properties:
      catalog:
        description: Gets the catalog endpoint.
        type: string
        readOnly: true
      guardian:
        description: Gets the guardian endpoint.
        type: string
        readOnly: true
      scan:
        description: Gets the scan endpoint.
        type: string
        readOnly: true
  AccountUpdateParameters:
    description: Update parameters for accounts
    type: object
    properties:
      tags:
        description: Tags on the azure resource.
        type: object
        additionalProperties:
          type: string
  AccountEndpoints:
    description: The account endpoints
    type: object
    properties:
      catalog:
        description: Gets the catalog endpoint.
        type: string
        readOnly: true
      scan:
        description: Gets the scan endpoint.
        type: string
        readOnly: true
  AccountResponse:
    additionalProperties: false
    properties:
      etag:
        type: string
        description: ETag for use with If-Match headers for optimistic concurrency.
      name:
        minLength: 1
        type: string
        description: Name of the account.
      details:
        $ref: '#/definitions/AccountDetails'
    required:
    - name
    type: object
    description: Details of the account as returned on a GET request.
  OperationResponse:
    description: Response for long running operation
    required:
    - status
    type: object
    properties:
      endTime:
        format: date-time
        description: start time
        type: string
      error:
        $ref: '#/definitions/DataShareErrorInfo'
        description: The error property when status is failed.
      startTime:
        format: date-time
        description: start time
        type: string
      status:
        description: Operation state of the long running operation.
        enum:
        - Accepted
        - InProgress
        - TransientFailure
        - Succeeded
        - Failed
        - Canceled
        type: string
        x-ms-enum:
          name: status
          modelAsString: true
  ErrorModel_2:
    description: Default error model
    type: object
    properties:
      code:
        description: Gets or sets the code.
        type: string
        readOnly: true
      details:
        description: Gets or sets the details.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ErrorModel_2'
        readOnly: true
      message:
        description: Gets or sets the messages.
        type: string
        readOnly: true
      target:
        description: Gets or sets the target.
        type: string
        readOnly: true
  UserAssignedIdentity:
    description: Uses client ID and Principal ID
    type: object
    properties:
      clientId:
        description: Gets or Sets Client ID
        type: string
        readOnly: true
      principalId:
        description: Gets or Sets Principal ID
        type: string
        readOnly: true
  AccountList_2:
    description: Paged list of account resources
    required:
    - value
    type: object
    properties:
      count:
        format: int64
        description: Total item count.
        type: integer
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type results.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Account_3'
  ManagedResources:
    description: The managed resources in customer subscription.
    type: object
    properties:
      eventHubNamespace:
        description: Gets the managed event hub namespace resource identifier.
        type: string
        readOnly: true
      resourceGroup:
        description: Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.
        type: string
        readOnly: true
      storageAccount:
        description: Gets the managed storage account resource identifier.
        type: string
        readOnly: true
  SubdomainProvisioningStatus:
    enum:
    - Provisioned
    - NotProvisioned
    - Inconsistent
    type: string
    description: Status of DNS configuration. Azure Communications Gateway generates DNS records to Microsoft 365 to verify that the customer-specific domain name is associated with the correct customer tenant.
    x-ms-enum:
      name: SubdomainProvisioningStatus
      modelAsString: true
      values:
      - value: Provisioned
        description: DNS state is provisioned.
        name: Provisioned
      - value: NotProvisioned
        description: DNS state has not been provisioned.
        name: NotProvisioned
      - value: Inconsistent
        description: The programmed DNS state doesn't match the requested programming.
        name: Inconsistent
  Identity:
    description: The Managed Identity of the resource
    type: object
    properties:
      principalId:
        description: Service principal object Id
        type: string
        readOnly: true
      tenantId:
        description: Tenant Id
        type: string
        readOnly: true
      type:
        description: Identity Type
        enum:
        - None
        - SystemAssigned
        - UserAssigned
        type: string
        x-ms-enum:
          name: ManagedIdentityType
          modelAsString: true
      userAssignedIdentities:
        description: User Assigned Identities
        type: object
        additionalProperties:
          $ref: '#/definitions/UserAssignedIdentity'
  ProxyDto:
    description: Base data transfer object implementation for proxy resources.
    type: object
    properties:
      id:
        description: The resource id of the azure resource
        type: string
        readOnly: true
      name:
        description: Name of the azure resource
        type: string
        readOnly: true
      type:
        description: Type of the azure resource
        type: string
        readOnly: true
    x-ms-azure-resource: true
  Identity_2:
    description: Identity of resource
    type: object
    properties:
      principalId:
        description: service principal Id
        type: string
        readOnly: true
      tenantId:
        description: Tenant Id
        type: string
        readOnly: true
      type:
        description: Identity Type
        enum:
        - SystemAssigned
        type: string
        x-ms-enum:
          name: type
          modelAsString: true
  ErrorResponseModel_2:
    description: Default error response model
    type: object
    properties:
      error:
        description: Gets or sets the error.
        allOf:
        - $ref: '#/definitions/ErrorModel_2'
        readOnly: true
  AccountUpdateParameters_2:
    description: The account update properties.
    type: object
    properties:
      properties:
        $ref: '#/definitions/AccountProperties_3'
        description: The account properties.
      tags:
        description: Tags on the azure resource.
        type: object
        additionalProperties:
          type: string
  AccountSku_2:
    description: The Sku
    type: object
    properties:
      capacity:
        format: int32
        description: Gets or sets the sku capacity.
        type: integer
      name:
        description: Gets or sets the sku name.
        enum:
        - Standard
        type: string
        x-ms-enum:
          name: name
          modelAsString: true
  AccountSku:
    description: The Sku
    type: object
    properties:
      capacity:
        format: int32
        description: Gets or sets the sku capacity.
        type: integer
      name:
        description: Gets or sets the sku name.
        enum:
        - Standard
        - Free
        type: string
        x-ms-enum:
          name: AccountSkuName
          modelAsString: true
  CloudConnectors_2:
    type: object
    properties:
      awsExternalId:
        description: "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning"
        type: string
        readOnly: true
  Account_2:
    description: An account data transfer object.
    required:
    - identity
    type: object
    allOf:
    - $ref: '#/definitions/DefaultDto'
    properties:
      identity:
        $ref: '#/definitions/Identity_2'
        description: Identity Info on the Account
      properties:
        $ref: '#/definitions/AccountProperties_2'
        description: Properties on the account
        x-ms-client-flatten: true
  PrivateEndpointConnection:
    description: A private endpoint connection class.
    type: object
    properties:
      id:
        description: Gets or sets the identifier.
        type: string
        readOnly: true
      name:
        description: Gets or sets the name.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionProperties'
      systemData:
        $ref: '#/definitions/SystemData'
      type:
        description: Gets or sets the type.
        type: string
        readOnly: true
  SubdomainProvisioningState:
    additionalProperties: false
    properties:
      subdomainTokens:
        $ref: '#/definitions/TeamsDrSubdomainTokens'
      subdomainStatus:
        $ref: '#/definitions/SubdomainProvisioningStatus'
    required:
    - subdomainStatus
    type: object
    description: Status of DNS configuration and the DNS TXT values for the DNS records
  PrivateLinkServiceConnectionState_2:
    description: The private link service connection state.
    type: object
    properties:
      actionsRequired:
        description: The required actions.
        type: string
      description:
        description: The description.
        type: string
      status:
        description: The status.
        enum:
        - Unknown
        - Pending
        - Approved
        - Rejected
        - Disconnected
        type: string
        x-ms-enum:
          name: status
          modelAsString: true
  AccessKeyOptions:
    description: A access key options used for regeneration.
    type: object
    properties:
      keyType:
        description: The access key type.
        enum:
        - PrimaryAtlasKafkaKey
        - SecondaryAtlasKafkaKey
        type: string
        x-ms-enum:
          name: AccessKeyType
          modelAsString: true
  DataShareError:
    description: The data share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/DataShareErrorInfo'
        description: The data share error body
  AccountDetails:
    additionalProperties: false
    properties:
      directRouting:
        $ref: '#/definitions/TeamsDrConfig'
    type: object
    description: Details of the account.
  PrivateEndpointConnection_2:
    description: A private endpoint connection class.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionProperties_2'
        description: The connection identifier.
        x-ms-client-flatten: true
  AccountProperties:
    description: The account properties
    type: object
    properties:
      accountStatus:
        $ref: '#/definitions/AccountStatus'
      cloudConnectors:
        $ref: '#/definitions/CloudConnectors'
      createdAt:
        format: date-time
        description: Gets the time at which the entity was created.
        type: string
        readOnly: true
      createdBy:
        description: Gets the creator of the entity.
        type: string
        readOnly: true
      createdByObjectId:
        description: Gets the creators of the entity's object id.
        type: string
        readOnly: true
      defaultDomain:
        description: Gets or sets the default domain in the account.
        type: string
        readOnly: true
      endpoints:
        $ref: '#/definitions/AccountEndpoints'
      friendlyName:
        description: Gets or sets the friendly name.
        type: string
        readOnly: true
      ingestionStorage:
        $ref: '#/definitions/IngestionStorage'
      managedEventHubState:
        description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.
        default: NotSpecified
        enum:
        - NotSpecified
        - Disabled
        - Enabled
        type: string
        x-ms-enum:
          name: ManagedEventHubState
          modelAsString: true
      managedResourceGroupName:
        description: Gets or sets the managed resource group name
        type: string
      managedResources:
        $ref: '#/definitions/ManagedResources'
      managedResourcesPublicNetworkAccess:
        description: Gets or sets the public network access for managed resources
        enum:
        - NotSpecified
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: PublicNetworkAccess
          modelAsString: true
      mergeInfo:
        $ref: '#/definitions/AccountMergeInfo'
      privateEndpointConnections:
        description: Gets the private endpoint connections information.
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnection'
        readOnly: true
      provisioningState:
        description: Gets or sets the state of the provisioning.
        enum:
        - Unknown
        - Creating
        - Moving
        - Deleting
        - SoftDeleting
        - SoftDeleted
        - Failed
        - Succeeded
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      publicNetworkAccess:
        description: Gets or sets the public network access.
        default: Enabled
        enum:
        - NotSpecified
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: PublicNetworkAccess
          modelAsString: true
  ErrorResponse:
    title: Error details.
    description: Contains details when the response code indicates an error.
    type: object
    properties:
      error:
        description: The error details.
        $ref: '#/definitions/ErrorDetail'
    required:
    - error
  PrivateEndpointConnectionProperties_2:
    description: A private endpoint connection properties class.
    type: object
    properties:
      privateEndpoint:
        $ref: '#/definitions/PrivateEndpoint'
        description: The private endpoint information.
      privateLinkServiceConnectionState:
        $ref: '#/definitions/PrivateLinkServiceConnectionState_2'
        description: The private link service connection state.
      provisioningState:
        description: The provisioning state.
        type: string
        readOnly: true
  AccountProperties_3:
    description: The account properties
    type: object
    properties:
      cloudConnectors:
        $ref: '#/definitions/CloudConnectors_2'
        description: "Cloud connectors.\r\nExternal cloud identifier used as part of scanning configuration."
      createdAt:
        format: date-time
        description: Gets the time at which the entity was created.
        type: string
        readOnly: true
      createdBy:
        description: Gets the creator of the entity.
        type: string
        readOnly: true
      createdByObjectId:
        description: Gets the creators of the entity's object id.
        type: string
        readOnly: true
      endpoints:
        description: The URIs that are the public endpoints of the account.
        allOf:
        - $ref: '#/definitions/AccountEndpoints_2'
        readOnly: true
      friendlyName:
        description: Gets or sets the friendly name.
        type: string
        readOnly: true
      managedResourceGroupName:
        description: Gets or sets the managed resource group name
        type: string
        x-ms-mutability:
        - read
        - create
      managedResources:
        description: Gets the resource identifiers of the managed resources.
        allOf:
        - $ref: '#/definitions/ManagedResources'
        readOnly: true
      privateEndpointConnections:
        description: Gets the private endpoint connections information.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnection_2'
        readOnly: true
      provisioningState:
        description: Gets or sets the state of the provisioning.
        enum:
        - Unknown
        - Creating
        - Moving
        - Deleting
        - SoftDeleting
        - SoftDeleted
        - Failed
        - Succeeded
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: provisioningState
          modelAsString: true
      publicNetworkAccess:
        description: Gets or sets the public network access.
        default: Enabled
        enum:
        - NotSpecified
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: publicNetworkAccess
          modelAsString: true
      systemData:
        description: Metadata pertaining to creation and last modification of the resource.
        allOf:
        - $ref: '#/definitions/SystemData_2'
        readOnly: true
  ErrorResponseModel:
    description: Default error response model
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
  CloudConnectors:
    description: External Cloud Service connectors
    type: object
    properties:
      awsExternalId:
        description: "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning"
        type: string
        readOnly: true
  DefaultDto:
    description: Base data transfer object implementation for default resources.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyDto'
    properties:
      location:
        description: Location of the azure resource.
        type: string
      tags:
        description: Tags on the azure resource.
        type: object
        additionalProperties:
          type: string
  DataShareErrorInfo:
    description: The data share error body model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Code of the error
        type: string
      details:
        description: Nested details of the error model
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DataShareErrorInfo'
      message:
        description: Message of the error
        type: string
      target:
        description: Target of the error
        type: string
  IngestionStorage:
    description: Ingestion Storage Account Info
    type: object
    properties:
      id:
        description: Gets or sets the Id.
        type: string
        readOnly: true
      primaryEndpoint:
        description: Gets or sets the primary endpoint.
        type: string
        readOnly: true
      publicNetworkAccess:
        description: Gets or sets the public network access setting
        enum:
        - NotSpecified
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: PublicNetworkAccess
          modelAsString: true
  InnerError:
    title: More specific information on an error object.
    type: object
    properties:
      code:
        description: A machine readable error code.
        type: string
      innererror:
        description: Inner error details if they exist.
        $ref: '#/definitions/InnerError'
  SystemData:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    properties:
      createdAt:
        format: date-time
        description: The timestamp of resource creation (UTC).
        type: string
        readOnly: true
      createdBy:
        description: The identity that created the resource.
        type: string
        readOnly: true
      createdByType:
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        readOnly: true
        x-ms-enum:
          name: IdentityType
          modelAsString: true
      lastModifiedAt:
        format: date-time
        description: The timestamp of the last modification the resource (UTC).
        type: string
        readOnly: true
      lastModifiedBy:
        description: The identity that last modified the resource.
        type: string
        readOnly: true
      lastModifiedByType:
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        readOnly: true
        x-ms-enum:
          name: IdentityType
          modelAsString: true
  AccountWithStatusResponse:
    additionalProperties: false
    properties:
      etag:
        type: string
        description: ETag for use with If-Match headers for optimistic concurrency.
      name:
        minLength: 1
        type: string
        description: Name of the account.
      details:
        $ref: '#/definitions/AccountDetails'
      directRoutingProvisioningState:
        $ref: '#/definitions/SubdomainProvisioningState'
    required:
    - name
    type: object
    description: Details of the account and its DNS provisioning status as returned on a GET request.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client API version
    x-ms-parameter-location: client
  accountName_2:
    name: accountName
    in: path
    description: The name of the account.
    required: true
    type: string
    maxLength: 63
    minLength: 3
    pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
    x-ms-parameter-location: method
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  api-version:
    in: query
    name: api-version
    description: The api version to use.
    required: true
    type: string
    x-ms-client-name: ApiVersion
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription identifier
    required: true
    type: string
  api-version_3:
    name: api-version
    in: query
    description: The api version to use.
    required: true
    type: string
  api-version_2:
    name: api-version
    in: query
    description: The api version to use.
    required: true
    type: string
  accountName:
    name: accountName
    in: path
    description: The name of the share account.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'