Microsoft Azure StorageDomains API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector StorageDomains API
schemes:
- https
tags:
- name: StorageDomains
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageDomains
  : get:
      tags:
      - StorageDomains
      description: Retrieves all the storage domains in a manager.
      operationId: microsoftAzureStoragedomainsListbymanager
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of storage domains.
          schema:
            $ref: '#/definitions/StorageDomainList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        StorageDomainsListByManager:
          $ref: ./examples/StorageDomainsListByManager.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storagedomains
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageDomains/{storageDomainName}
  : get:
      tags:
      - StorageDomains
      description: Returns the properties of the specified storage domain name.
      operationId: microsoftAzureStoragedomainsGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: storageDomainName
        in: path
        description: The storage domain name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The storage domain.
          schema:
            $ref: '#/definitions/StorageDomain'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-examples:
        StorageDomainsGet:
          $ref: ./examples/StorageDomainsGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storagedomains Storagedomainname
    put:
      tags:
      - StorageDomains
      description: Creates or updates the storage domain.
      operationId: microsoftAzureStoragedomainsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: storageDomainName
        in: path
        description: The storage domain name.
        required: true
        type: string
      - name: storageDomain
        in: body
        description: The storageDomain.
        required: true
        schema:
          $ref: '#/definitions/StorageDomain'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the storage domain.
          schema:
            $ref: '#/definitions/StorageDomain'
        '202':
          description: Accepted the request to create or update the storage domain.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        StorageDomainsCreateOrUpdate:
          $ref: ./examples/StorageDomainsCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storagedomains Storagedomainname
    delete:
      tags:
      - StorageDomains
      description: Deletes the storage domain.
      operationId: microsoftAzureStoragedomainsDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: storageDomainName
        in: path
        description: The storage domain name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the storage domain.
        '204':
          description: Successfully deleted the storage domain.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        StorageDomainsDelete:
          $ref: ./examples/StorageDomainsDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storagedomains Storagedomainname
definitions:
  StorageDomainList:
    description: Collection of storage domains
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/StorageDomain'
  AsymmetricEncryptedSecret:
    description: This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null.
        type: string
      encryptionCertificateThumbprint:
        description: Thumbprint certificate that was used to encrypt "Value"
        type: string
      encryptionAlgorithm:
        description: Algorithm used to encrypt "Value"
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: false
  Message:
    type: object
    properties:
      language:
        type: string
      value:
        type: string
  StorageDomain:
    description: The storage domain.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/StorageDomainProperties'
        description: The properties.
        x-ms-client-flatten: true
  BaseModel:
    description: Base class for models
    type: object
    properties:
      id:
        description: The identifier.
        type: string
        readOnly: true
      name:
        description: The name.
        type: string
        readOnly: true
      type:
        description: The type.
        type: string
        readOnly: true
  StorageDomainProperties:
    description: The storage domain properties.
    required:
    - storageAccountCredentialIds
    - encryptionStatus
    type: object
    properties:
      storageAccountCredentialIds:
        description: The storage account credentials.
        type: array
        items:
          type: string
      encryptionKey:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The encryption key used to encrypt the data. This is a user secret.
      encryptionStatus:
        description: The encryption status "Enabled | Disabled".
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: EncryptionStatus
          modelAsString: false
  Item:
    required:
    - key
    - value
    type: object
    properties:
      key:
        type: string
      value:
        type: string
  Error:
    required:
    - errorCode
    - message
    type: object
    properties:
      errorCode:
        type: string
      message:
        $ref: '#/definitions/Message'
      values:
        type: array
        items:
          $ref: '#/definitions/Item'
        x-ms-identifiers:
        - key
parameters:
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'