Microsoft Azure StorageAccountCredentials API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector StorageAccountCredentials API
schemes:
- https
tags:
- name: StorageAccountCredentials
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials
  : get:
      tags:
      - StorageAccountCredentials
      summary: Microsoft Azure Gets All The Storage Account Credentials In A Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureStorageaccountcredentialsListbydataboxedgedevice
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of storage account credentials.
          schema:
            $ref: '#/definitions/StorageAccountCredentialList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SACGetAllInDevice:
          $ref: ./examples/SACGetAllInDevice.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}
  : get:
      tags:
      - StorageAccountCredentials
      description: Gets the properties of the specified storage account credential.
      operationId: microsoftAzureStorageaccountcredentialsGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The storage account credential name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The storage account credential properties.
          schema:
            $ref: '#/definitions/StorageAccountCredential'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        SACGet:
          $ref: ./examples/SACGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Storageaccountcredentials Name
    put:
      tags:
      - StorageAccountCredentials
      description: Creates or updates the storage account credential.
      operationId: microsoftAzureStorageaccountcredentialsCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The storage account credential name.
        required: true
        type: string
      - name: storageAccountCredential
        in: body
        description: The storage account credential.
        required: true
        schema:
          $ref: '#/definitions/StorageAccountCredential'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the storage account credential.
          schema:
            $ref: '#/definitions/StorageAccountCredential'
        '202':
          description: Accepted the request to create or update the storage account credential.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        SACPut:
          $ref: ./examples/SACPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Storageaccountcredentials Name
    delete:
      tags:
      - StorageAccountCredentials
      description: Deletes the storage account credential.
      operationId: microsoftAzureStorageaccountcredentialsDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The storage account credential name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the storage account credential.
        '202':
          description: Accepted the request to delete the storage account credential.
        '204':
          description: The storage account credential is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        SACDelete:
          $ref: ./examples/SACDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Storageaccountcredentials Name
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials
  : get:
      tags:
      - StorageAccountCredentials
      description: Gets all the storage account credentials in a manager.
      operationId: microsoftAzureStorageaccountcredentialsListbymanager
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The collection of storage account credentials.
          schema:
            $ref: '#/definitions/StorageAccountCredentialList_2'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        StorageAccountCredentialsListByManager:
          $ref: ./examples/StorageAccountCredentialsListByManager.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{storageAccountCredentialName}
  : get:
      tags:
      - StorageAccountCredentials
      description: Gets the properties of the specified storage account credential name.
      operationId: microsoftAzureStorageaccountcredentialsGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: storageAccountCredentialName
        in: path
        description: The name of storage account credential to be fetched.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The storage account credential.
          schema:
            $ref: '#/definitions/StorageAccountCredential_2'
      deprecated: false
      x-ms-examples:
        StorageAccountCredentialsGet:
          $ref: ./examples/StorageAccountCredentialsGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials Storageaccountcredentialname
    put:
      tags:
      - StorageAccountCredentials
      description: Creates or updates the storage account credential.
      operationId: microsoftAzureStorageaccountcredentialsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: storageAccountCredentialName
        in: path
        description: The storage account credential name.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: parameters
        in: body
        description: The storage account credential to be added or updated.
        required: true
        schema:
          $ref: '#/definitions/StorageAccountCredential_2'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: Successfully created or updated the storage account credential.
          schema:
            $ref: '#/definitions/StorageAccountCredential_2'
        '202':
          description: Accepted the request to create or update the storage account credential.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        StorageAccountCredentialsCreateOrUpdate:
          $ref: ./examples/StorageAccountCredentialsCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials Storageaccountcredentialname
    delete:
      tags:
      - StorageAccountCredentials
      description: Deletes the storage account credential.
      operationId: microsoftAzureStorageaccountcredentialsDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: storageAccountCredentialName
        in: path
        description: The name of the storage account credential.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to delete the storage account credential.
        '204':
          description: Successfully deleted the storage account credential.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        StorageAccountCredentialsDelete:
          $ref: ./examples/StorageAccountCredentialsDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials Storageaccountcredentialname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/storageAccountCredentials/{credentialName}
  : get:
      tags:
      - StorageAccountCredentials
      description: Returns the properties of the specified storage account credential name.
      operationId: microsoftAzureStorageaccountcredentialsGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: credentialName
        in: path
        description: The name of storage account credential to be fetched.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '200':
          description: The storage account credential.
          schema:
            $ref: '#/definitions/StorageAccountCredential_3'
        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:
        StorageAccountCredentialsGet:
          $ref: ./examples/StorageAccountCredentialsGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials Credentialname
    put:
      tags:
      - StorageAccountCredentials
      description: Creates or updates the storage account credential
      operationId: microsoftAzureStorageaccountcredentialsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: credentialName
        in: path
        description: The credential name.
        required: true
        type: string
      - name: storageAccount
        in: body
        description: The storage account credential to be added or updated.
        required: true
        schema:
          $ref: '#/definitions/StorageAccountCredential_3'
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '200':
          description: Successfully created or updated the storage account credential.
          schema:
            $ref: '#/definitions/StorageAccountCredential_3'
        '202':
          description: Accepted the request to create or update the storage account credential.
        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:
        StorageAccountCredentialsCreateOrUpdate:
          $ref: ./examples/StorageAccountCredentialsCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials Credentialname
    delete:
      tags:
      - StorageAccountCredentials
      description: Deletes the storage account credential
      operationId: microsoftAzureStorageaccountcredentialsDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: credentialName
        in: path
        description: The name of the storage account credential.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '202':
          description: Accepted the request to delete the storage account credential.
        '204':
          description: Successfully deleted the storage account credential.
        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:
        StorageAccountCredentialsDelete:
          $ref: ./examples/StorageAccountCredentialsDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Storageaccountcredentials Credentialname
definitions:
  StorageAccountCredentialProperties:
    description: The storage account credential properties.
    required:
    - alias
    - sslStatus
    - accountType
    type: object
    properties:
      alias:
        description: Alias for the storage account.
        type: string
      userName:
        description: Username for the storage account.
        type: string
      accountKey:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: Encrypted storage key.
      connectionString:
        description: Connection string for the storage account. Use this string if username and account key are not specified.
        type: string
      sslStatus:
        description: Signifies whether SSL needs to be enabled or not.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: SSLStatus
          modelAsString: true
      blobDomainName:
        description: Blob end point for private clouds.
        type: string
      accountType:
        description: Type of storage accessed on the storage account.
        enum:
        - GeneralPurposeStorage
        - BlobStorage
        type: string
        x-ms-enum:
          name: AccountType
          modelAsString: true
      storageAccountId:
        description: Id of the storage account.
        type: string
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  AsymmetricEncryptedSecret_2:
    description: Represent the secrets intended for encryption with asymmetric key pair.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret.
        type: string
      encryptionCertThumbprint:
        description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null.
        type: string
      encryptionAlgorithm:
        description: The algorithm used to encrypt "Value".
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: false
  StorageAccountCredentialList:
    description: The collection of storage account credentials.
    type: object
    properties:
      value:
        description: The value.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/StorageAccountCredential'
        readOnly: true
        x-ms-identifiers: []
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
  AsymmetricEncryptedSecret_3:
    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
  StorageAccountCredential:
    description: The storage account credential.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/StorageAccountCredentialProperties'
        description: The storage account credential properties.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of StorageAccountCredential
        readOnly: true
  BaseModel:
    description: Represents the base class for all other ARM object models
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The name of the object.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
      kind:
        description: The Kind of the object. Currently only Series8000 is supported
        enum:
        - Series8000
        type: string
        x-ms-enum:
          name: Kind
          modelAsString: false
  StorageAccountCredential_3:
    description: The storage account credential
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel_2'
    properties:
      properties:
        $ref: '#/definitions/StorageAccountCredentialProperties_3'
        description: Credential properties
        x-ms-client-flatten: true
  StorageAccountCredentialProperties_2:
    description: The storage account credential properties.
    required:
    - endPoint
    - sslStatus
    type: object
    properties:
      endPoint:
        description: The storage endpoint
        type: string
      sslStatus:
        description: Signifies whether SSL needs to be enabled or not.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: SslStatus
          modelAsString: false
      accessKey:
        $ref: '#/definitions/AsymmetricEncryptedSecret_2'
        description: The details of the storage account password.
      volumesCount:
        format: int32
        description: The count of volumes using this storage account credential.
        type: integer
        readOnly: true
  Item:
    required:
    - key
    - value
    type: object
    properties:
      key:
        type: string
      value:
        type: string
  StorageAccountCredentialProperties_3:
    description: Storage account properties
    required:
    - cloudType
    - endPoint
    - login
    - enableSSL
    type: object
    properties:
      cloudType:
        description: The cloud service provider
        enum:
        - Azure
        - S3
        - S3_RRS
        - OpenStack
        - HP
        type: string
        x-ms-enum:
          name: CloudType
          modelAsString: false
      endPoint:
        description: The storage endpoint
        type: string
      login:
        description: The storage account login
        type: string
      location:
        description: The storage account's geo location
        type: string
      enableSSL:
        description: SSL needs to be enabled or not
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: SslStatus
          modelAsString: false
      accessKey:
        $ref: '#/definitions/AsymmetricEncryptedSecret_3'
        description: The details of the storage account password
  Message:
    type: object
    properties:
      language:
        type: string
      value:
        type: string
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  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
  AsymmetricEncryptedSecret:
    description: Represent the secrets intended for encryption with asymmetric key pair.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret.
        type: string
      encryptionCertThumbprint:
        description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null.
        x-ms-secret: true
        type: string
      encryptionAlgorithm:
        description: The algorithm used to encrypt "Value".
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: true
  StorageAccountCredentialList_2:
    description: The collection of storage account credential entities.
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/StorageAccountCredential_2'
  BaseModel_2:
    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
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  StorageAccountCredential_2:
    description: The storage account credential.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/StorageAccountCredentialProperties_2'
        description: The storage account credential properties.
        x-ms-client-flatten: true
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  resourceGroupNameParameter_2:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  apiVersionParameter_2:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
    x-ms-skip-url-encoding: true
  apiVersionParameter_3:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
  subscriptionIdParameter_2:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
    x-ms-skip-url-encoding: true
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  managerNameParameter_2:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
  resourceGroupNameParameter_3:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  subscriptionIdParameter_3:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'