openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft.Elastic Deployment Info API
  version: 2024-01-01-preview
servers:
- url: https://management.azure.com
tags:
- name: Deployment Info
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo
  : post:
      tags:
      - Deployment Info
      summary: Microsoft Azure Fetch Information Regarding Elastic Cloud Deployment…
      operationId: microsoftAzureDeploymentinfoList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentInfoResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        DeploymentInfo_List:
          $ref: ./examples/DeploymentInfo_List.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser
  : post:
      tags:
      - Deployment Info
      summary: Microsoft Azure Create User Inside Elastic Deployment Which Are Used By…
      operationId: microsoftAzureExternaluserCreateorupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalUserCreationResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        ExternalUser_CreateOrUpdate:
          $ref: ./examples/ExternalUserInfo.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalUserInfo'
        description: Elastic External User Creation Parameters
components:
  schemas:
    ExternalUserCreationResponse:
      description: The properties of the response we got from elastic while creating external user
      type: object
      properties:
        created:
          description: Shows if user is created or updated
          type: boolean
          readOnly: true
    ElasticDeploymentStatus:
      description: Flag specifying if the Elastic deployment status is healthy or not.
      enum:
      - Healthy
      - Unhealthy
      type: string
      x-ms-enum:
        modelAsString: true
        name: ElasticDeploymentStatus
    ResourceProviderDefaultErrorResponse:
      description: RP default error response.
      type: object
      properties:
        error:
          description: Response body of Error
          readOnly: true
          $ref: '#/components/schemas/ErrorResponseBody'
    ErrorResponseBody:
      description: Error response body.
      title: ErrorResponseBody
      type: object
      properties:
        code:
          description: Error code.
          type: string
        message:
          description: Error message.
          type: string
        target:
          description: Error target.
          type: string
        details:
          description: Error details.
          type: array
          x-ms-identifiers: []
          items:
            $ref: '#/components/schemas/ErrorResponseBody'
    ExternalUserInfo:
      description: The properties of the request required for creating user on elastic side
      type: object
      properties:
        userName:
          description: Username of the user to be created or updated
          type: string
        fullName:
          description: Full name of the user to be created or updated
          type: string
        password:
          x-ms-secret: true
          description: Password of the user to be created or updated
          type: string
        emailId:
          description: Email id of the user to be created or updated
          type: string
        roles:
          description: Roles to be assigned for  created or updated user
          type: array
          x-ms-identifiers: []
          items:
            type: string
    MarketplaceSaaSInfo:
      description: Marketplace SAAS Info of the resource.
      type: object
      properties:
        marketplaceSubscription:
          description: Marketplace Subscription
          type: object
          properties:
            id:
              description: Marketplace Subscription Id. This is a GUID-formatted string.
              type: string
        marketplaceName:
          description: 'Marketplace Subscription Details: SAAS Name'
          type: string
        marketplaceResourceId:
          description: 'Marketplace Subscription Details: Resource URI'
          type: string
        marketplaceStatus:
          description: 'Marketplace Subscription Details: SaaS Subscription Status'
          type: string
        billedAzureSubscriptionId:
          description: The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.
          type: string
        subscribed:
          description: Flag specifying if the Marketplace status is subscribed or not.
          type: boolean
    DeploymentInfoResponse:
      description: The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.
      type: object
      properties:
        status:
          description: The Elastic deployment status.
          $ref: '#/components/schemas/ElasticDeploymentStatus'
          readOnly: true
        version:
          description: Version of the elasticsearch in Elastic cloud deployment.
          type: string
          readOnly: true
        memoryCapacity:
          description: RAM capacity of the elasticsearch in Elastic cloud deployment.
          type: string
          readOnly: true
        diskCapacity:
          description: Disk capacity of the elasticsearch in Elastic cloud deployment.
          type: string
          readOnly: true
        elasticsearchEndPoint:
          description: Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise.
          type: string
          readOnly: true
        deploymentUrl:
          description: Deployment URL of the elasticsearch in Elastic cloud deployment.
          type: string
          readOnly: true
        marketplaceSaasInfo:
          description: Marketplace SaaS Info of the resource.
          $ref: '#/components/schemas/MarketplaceSaaSInfo'
          readOnly: true
  parameters:
    MonitorNameParameter:
      in: path
      name: monitorName
      description: Monitor resource name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Microsoft Entra ID OAuth2 Flow