Microsoft Azure Datastores API

openapi: 3.2.0
info:
  title: Microsoft Azure Datastores API
  version: '1.0'
  description: 'Operations tagged Datastores across 2 of this provider''s published API definitions: azure-arc-vmware-management-service-api-openapi-original.yml, hybriddatamanagementclient-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Datastores
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/datastores/{datastoreName}
  : put:
      tags:
      - Datastores
      operationId: microsoftAzureDatastoresCreate
      description: Create Or Update datastore.
      summary: Microsoft Azure Implements Datastore Put Method
      x-ms-examples:
        CreateDatastore:
          $ref: ./examples/CreateDatastore.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - in: path
        name: datastoreName
        required: true
        description: Name of the datastore.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Arm resource update successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datastore'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datastore'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Datastore'
        description: Request payload.
    get:
      tags:
      - Datastores
      operationId: microsoftAzureDatastoresGet
      summary: Microsoft Azure Gets A Datastore
      description: Implements datastore GET method.
      x-ms-examples:
        GetDatastore:
          $ref: ./examples/GetDatastore.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - in: path
        name: datastoreName
        description: Name of the datastore.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datastore'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
    patch:
      tags:
      - Datastores
      operationId: microsoftAzureDatastoresUpdate
      summary: Microsoft Azure Updates A Datastore
      description: API to update certain properties of the datastore resource.
      x-ms-examples:
        UpdateDatastore:
          $ref: ./examples/UpdateDatastore.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - in: path
        name: datastoreName
        required: true
        description: Name of the datastore.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Arm resource update successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datastore'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourcePatch'
        description: Resource properties to update.
    delete:
      tags:
      - Datastores
      operationId: microsoftAzureDatastoresDelete
      summary: Microsoft Azure Deletes An Datastore
      description: Implements datastore DELETE method.
      x-ms-examples:
        DeleteDatastore:
          $ref: ./examples/DeleteDatastore.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - in: path
        name: datastoreName
        description: Name of the datastore.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - in: query
        name: force
        description: Whether force delete was specified.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success
        '202':
          description: Accepted
          headers:
            Location:
              schema:
                type: string
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/datastores:
    get:
      tags:
      - Datastores
      operationId: microsoftAzureDatastoresList
      summary: Microsoft Azure Implements Get Datastores In A Subscription
      description: List of datastores in a subscription.
      x-ms-examples:
        ListDatastores:
          $ref: ./examples/ListDatastores.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatastoresList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/datastores:
    get:
      tags:
      - Datastores
      operationId: microsoftAzureDatastoresListbyresourcegroup
      summary: Microsoft Azure Implements Get Datastores In A Resource Group
      description: List of datastores in a resource group.
      x-ms-examples:
        ListDatastoresByResourceGroup:
          $ref: ./examples/ListDatastoresByResourceGroup.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatastoresList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores
  : get:
      tags:
      - Datastores
      description: Gets all the data stores/repositories in the given resource.
      operationId: microsoftAzureDatastoresListbydatamanager
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/dataManagerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      - name: $filter
        in: query
        description: OData Filter options
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The list of data stores/repositories in the given resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreList'
      x-ms-odata: '#/definitions/DataStoreFilter'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        DataStores_ListByDataManagerGET151:
          $ref: ./examples/DataStores_ListByDataManager-GET-example-151.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}
  : get:
      tags:
      - Datastores
      description: This method gets the data store/repository by name.
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftHybridDataDataManagersByDataManagerNameDataStoresByDataStoreName
      parameters:
      - name: dataStoreName
        in: path
        description: The data store/repository name queried.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/dataManagerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The data store/repository which matches the name given.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStore'
      x-ms-examples:
        DataStores_GetGET161:
          $ref: ./examples/DataStores_Get-GET-example-161.json
        DataStores_GetGET162:
          $ref: ./examples/DataStores_Get-GET-example-162.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureDatastoresGet
    put:
      tags:
      - Datastores
      description: Creates or updates the data store/repository in the data manager.
      operationId: microsoftAzureDatastoresCreateorupdate
      parameters:
      - name: dataStoreName
        in: path
        description: The data store/repository name to be created or updated.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/dataManagerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The data store/repository object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStore'
        '202':
          description: Accepted request for create/update.
      x-ms-long-running-operation: true
      x-ms-examples:
        DataStores_CreateOrUpdate_DataSinkPUT162:
          $ref: ./examples/DataStores_CreateOrUpdate_DataSink-PUT-example-162.json
        DataStores_CreateOrUpdate_DataSourcePUT162:
          $ref: ./examples/DataStores_CreateOrUpdate_DataSource-PUT-example-162.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStore'
        description: The data store/repository object to be created or updated.
        required: true
    delete:
      tags:
      - Datastores
      description: This method deletes the given data store/repository.
      operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftHybridDataDataManagersByDataManagerNameDataStoresByDataStoreName
      parameters:
      - name: dataStoreName
        in: path
        description: The data store/repository name to be deleted.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/dataManagerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted request for DataStore deletion.
        '204':
          description: DataStore deleted.
      x-ms-long-running-operation: true
      x-ms-examples:
        DataStores_Delete_DataSinkDELETE161:
          $ref: ./examples/DataStores_Delete_DataSink-DELETE-example-161.json
        DataStores_Delete_DataSourceDELETE161:
          $ref: ./examples/DataStores_Delete_DataSource-DELETE-example-161.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureDatastoresDelete
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ResourceProvisioningState:
      type: string
      description: The current deployment state of resource.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Provisioning
      - Updating
      - Deleting
      - Accepted
      - Created
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
    ExtendedLocation:
      type: object
      description: The extended location.
      properties:
        type:
          type: string
          description: The extended location type.
        name:
          type: string
          description: The extended location name.
    DatastoresList:
      description: List of Datastores.
      type: object
      properties:
        nextLink:
          description: Url to follow for getting next page of Datastores.
          type: string
        value:
          description: Array of Datastores
          type: array
          items:
            $ref: '#/components/schemas/Datastore'
      required:
      - value
    Datastore:
      description: Define the datastore.
      required:
      - location
      - properties
      type: object
      x-ms-azure-resource: true
      properties:
        properties:
          x-ms-client-flatten: true
          description: Resource properties.
          $ref: '#/components/schemas/DatastoreProperties'
        location:
          description: Gets or sets the location.
          type: string
          x-ms-mutability:
          - read
          - create
        extendedLocation:
          $ref: '#/components/schemas/ExtendedLocation'
          description: Gets or sets the extended location.
        systemData:
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
          description: The system data.
        tags:
          description: Gets or sets the Resource tags.
          type: object
          additionalProperties:
            type: string
        name:
          description: Gets or sets the name.
          type: string
          readOnly: true
        id:
          description: Gets or sets the Id.
          type: string
          readOnly: true
        type:
          description: Gets or sets the type of the resource.
          type: string
          readOnly: true
        kind:
          type: string
          description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.
    ResourceStatus:
      description: The resource status information.
      type: object
      properties:
        type:
          description: The type of the condition.
          type: string
          readOnly: true
        status:
          description: Status of the condition.
          type: string
          readOnly: true
        reason:
          description: The reason for the condition's status.
          type: string
          readOnly: true
        message:
          description: A human readable message indicating details about the status.
          type: string
          readOnly: true
        severity:
          description: Severity with which to treat failures of this type of condition.
          type: string
          readOnly: true
        lastUpdatedAt:
          description: The last update time for this condition.
          type: string
          format: date-time
          readOnly: true
    ResourcePatch:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
      description: Object containing updates for patch operations.
    DatastoreProperties:
      description: Describes the properties of a Datastore.
      type: object
      properties:
        uuid:
          description: Gets or sets a unique identifier for this resource.
          type: string
          readOnly: true
        vCenterId:
          description: Gets or sets the ARM Id of the vCenter resource in which this datastore resides.
          type: string
        moRefId:
          description: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the datastore.
          type: string
        inventoryItemId:
          description: Gets or sets the inventory Item ID for the datastore.
          type: string
        moName:
          description: Gets or sets the vCenter Managed Object name for the datastore.
          type: string
          readOnly: true
        statuses:
          description: The resource status information.
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/ResourceStatus'
          x-ms-identifiers:
          - type
        customResourceName:
          description: Gets the name of the corresponding resource in Kubernetes.
          type: string
          readOnly: true
        capacityGB:
          description: Gets or sets Maximum capacity of this datastore in GBs.
          format: int64
          type: integer
          readOnly: true
        freeSpaceGB:
          description: Gets or sets Available space of this datastore in GBs.
          format: int64
          type: integer
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ResourceProvisioningState'
          description: Provisioning state of the resource.
          readOnly: true
    DataStore:
      description: Data store.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/DmsBaseObject'
      properties:
        properties:
          $ref: '#/components/schemas/DataStoreProperties'
          description: DataStore properties.
          x-ms-client-flatten: true
    DmsBaseObject:
      description: Base class for all objects under DataManager Service
      type: object
      properties:
        name:
          description: Name of the object.
          type: string
          readOnly: true
        id:
          description: Id of the object.
          type: string
          readOnly: true
        type:
          description: Type of the object.
          type: string
          readOnly: true
    DataStoreProperties:
      description: Data Store for sources and sinks
      required:
      - state
      - dataStoreTypeId
      type: object
      properties:
        repositoryId:
          description: Arm Id for the manager resource to which the data source is associated. This is optional.
          type: string
        state:
          description: State of the data source.
          enum:
          - Disabled
          - Enabled
          - Supported
          type: string
          x-ms-enum:
            name: State
            modelAsString: false
        extendedProperties:
          description: A generic json used differently by each data source type.
          type: object
        dataStoreTypeId:
          description: The arm id of the data store type.
          type: string
        customerSecrets:
          description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys.
          type: array
          items:
            $ref: '#/components/schemas/CustomerSecret'
    DataStoreList:
      description: Data Store Collection.
      type: object
      properties:
        value:
          description: List of data stores.
          type: array
          items:
            $ref: '#/components/schemas/DataStore'
        nextLink:
          description: Link for the next set of data stores.
          type: string
    CustomerSecret:
      description: The pair of customer secret.
      required:
      - keyIdentifier
      - keyValue
      - algorithm
      type: object
      properties:
        keyIdentifier:
          description: The identifier to the data service input object which this secret corresponds to.
          type: string
        keyValue:
          description: It contains the encrypted customer secret.
          type: string
        algorithm:
          description: The encryption algorithm used to encrypt data.
          enum:
          - None
          - RSA1_5
          - RSA_OAEP
          - PlainText
          type: string
          x-ms-enum:
            name: SupportedAlgorithm
            modelAsString: false
  parameters:
    api-version:
      in: query
      name: api-version
      description: Client Api Version.
      required: true
      schema:
        type: string
    subscriptionId:
      in: path
      name: subscriptionId
      description: The Subscription ID.
      required: true
      schema:
        type: string
    resourceGroupName:
      in: path
      name: resourceGroupName
      description: The Resource Group Name.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The Resource Group Name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    dataManagerNameParameter:
      name: dataManagerName
      in: path
      description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 24
        minLength: 3
        pattern: ^[-\w\.]+$
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The Subscription Id
      required: true
      schema:
        type: string
    apiVersionParameter:
      name: api-version
      in: query
      description: The API Version
      required: true
      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: Azure Active Directory OAuth2 Flow.
x-refined-from:
- azure-arc-vmware-management-service-api-openapi-original.yml
- hybriddatamanagementclient-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'