Microsoft Azure ShareSubscription API

openapi: 3.2.0
info:
  version: 2018-11-01-preview
  title: Microsoft Azure DataShareManagementClient Share…
  description: Creates a Microsoft.DataShare management client.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ShareSubscription
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization
  : post:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Request Cancellation Of A Data Share Snapshot
      description: Request to cancel a synchronization.
      operationId: microsoftAzureSharesubscriptionsCancelsynchronization
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the shareSubscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscriptionSynchronization'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscriptionSynchronization'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        ShareSubscriptions_CancelSynchronization:
          $ref: ./examples/ShareSubscriptions_CancelSynchronization.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareSubscriptionSynchronization'
        description: Share Subscription Synchronization payload.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/consumerSourceDataSets
  : get:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Get Source Datasets Of A Sharesubscription
      description: Get source dataSets of a shareSubscription
      operationId: microsoftAzureConsumersourcedatasetsListbysharesubscription
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the shareSubscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - name: $skipToken
        in: query
        description: Continuation token
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerSourceDataSetList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ConsumerSourceDataSets_ListByShareSubscription:
          $ref: ./examples/ConsumerSourceDataSets_ListByShareSubscription.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSourceShareSynchronizationSettings
  : post:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Get Source Share Synchronization Settings For A…
      description: Get synchronization settings set on a share
      operationId: microsoftAzureSharesubscriptionsListsourcesharesynchronizationsettings
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the shareSubscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - name: $skipToken
        in: query
        description: Continuation token
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceShareSynchronizationSettingList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ShareSubscriptions_ListSourceShareSynchronizationSettings:
          $ref: ./examples/ShareSubscriptions_ListSourceShareSynchronizationSettings.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails
  : post:
      tags:
      - ShareSubscription
      summary: Microsoft Azure List Data Set Level Details For A Share Subscription…
      description: List synchronization details
      operationId: microsoftAzureSharesubscriptionsListsynchronizationdetails
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the share subscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - name: $skipToken
        in: query
        description: Continuation token
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results using OData syntax.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results using OData syntax.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynchronizationDetailsList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ShareSubscriptions_ListSynchronizationDetails:
          $ref: ./examples/ShareSubscriptions_ListSynchronizationDetails.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareSubscriptionSynchronization'
        description: Share Subscription Synchronization payload.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations
  : post:
      tags:
      - ShareSubscription
      summary: Microsoft Azure List Synchronizations In A Share Subscription
      description: List synchronizations of a share subscription
      operationId: microsoftAzureSharesubscriptionsListsynchronizations
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the share subscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - name: $skipToken
        in: query
        description: Continuation token
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results using OData syntax.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results using OData syntax.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscriptionSynchronizationList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ShareSubscriptions_ListSynchronizations:
          $ref: ./examples/ShareSubscriptions_ListSynchronizations.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/synchronize
  : post:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Initiate An Asynchronous Data Share Job
      description: Initiate a copy
      operationId: microsoftAzureSharesubscriptionsSynchronize
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of share subscription
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscriptionSynchronization'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscriptionSynchronization'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        ShareSubscriptions_Synchronize:
          $ref: ./examples/ShareSubscriptions_Synchronize.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Synchronize'
        description: Synchronize payload
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
  : get:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Get Sharesubscription In An Account
      description: Get a shareSubscription in an account
      operationId: microsoftAzureSharesubscriptionsGet
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the shareSubscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscription'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-examples:
        ShareSubscriptions_Get:
          $ref: ./examples/ShareSubscriptions_Get.json
    put:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Create Sharesubscription In An Account
      description: Create a shareSubscription in an account
      operationId: microsoftAzureSharesubscriptionsCreate
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the shareSubscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscription'
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscription'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-examples:
        ShareSubscriptions_Create:
          $ref: ./examples/ShareSubscriptions_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareSubscription'
        description: create parameters for shareSubscription
        required: true
    delete:
      tags:
      - ShareSubscription
      summary: Microsoft Azure Delete Sharesubscription In An Account
      description: Delete a shareSubscription in an account
      operationId: microsoftAzureSharesubscriptionsDelete
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: shareSubscriptionName
        in: path
        description: The name of the shareSubscription.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
        '202':
          description: Accepted
        '204':
          description: Success
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ShareSubscriptions_Delete:
          $ref: ./examples/ShareSubscriptions_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions
  : get:
      tags:
      - ShareSubscription
      summary: Microsoft Azure List Of Available Share Subscriptions Under An Account
      description: List share subscriptions in an account
      operationId: microsoftAzureSharesubscriptionsListbyaccount
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - $ref: '#/components/parameters/api-version'
      - name: $skipToken
        in: query
        description: Continuation Token
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results using OData syntax.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results using OData syntax.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareSubscriptionList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ShareSubscriptions_ListByAccount:
          $ref: ./examples/ShareSubscriptions_ListByAccount.json
components:
  schemas:
    Synchronize:
      description: Payload for the synchronizing the data.
      type: object
      properties:
        synchronizationMode:
          description: Mode of synchronization used in triggers and snapshot sync. Incremental by default
          enum:
          - Incremental
          - FullSync
          type: string
          x-ms-enum:
            name: synchronizationMode
            modelAsString: true
    ShareSubscription:
      description: A share subscription data transfer object.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyDto'
      properties:
        properties:
          $ref: '#/components/schemas/ShareSubscriptionProperties'
          description: Properties on the share subscription
          x-ms-client-flatten: true
    ShareSubscriptionSynchronizationList:
      description: A consumer side list of share subscription synchronizations
      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: '#/components/schemas/ShareSubscriptionSynchronization'
    DataShareError:
      description: The data share error model.
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/DataShareErrorInfo'
          description: The data share error body
    ShareSubscriptionSynchronization:
      description: A ShareSubscriptionSynchronization data transfer object.
      required:
      - synchronizationId
      type: object
      properties:
        durationMs:
          format: int32
          description: Synchronization duration
          type: integer
          readOnly: true
        endTime:
          format: date-time
          description: End time of synchronization
          type: string
          readOnly: true
        message:
          description: message of Synchronization
          type: string
          readOnly: true
        startTime:
          format: date-time
          description: start time of synchronization
          type: string
          readOnly: true
        status:
          description: Raw Status
          type: string
          readOnly: true
        synchronizationId:
          description: Synchronization id
          type: string
        synchronizationMode:
          description: Synchronization Mode
          enum:
          - Incremental
          - FullSync
          type: string
          readOnly: true
          x-ms-enum:
            name: synchronizationMode
            modelAsString: true
    ConsumerSourceDataSet:
      description: A consumer side dataSet data transfer object.
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyDto'
      properties:
        properties:
          $ref: '#/components/schemas/ConsumerSourceDataSetProperties'
          description: source dataSet properties
          x-ms-client-flatten: true
    SourceShareSynchronizationSetting:
      description: A view of synchronization setting added by the provider
      required:
      - kind
      type: object
      properties:
        kind:
          description: Kind of synchronization setting on share.
          enum:
          - ScheduleBased
          type: string
          x-ms-enum:
            name: sourceShareSynchronizationSettingKind
            modelAsString: true
      discriminator:
        propertyName: kind
    SynchronizationDetails:
      description: Synchronization details at data set level
      type: object
      properties:
        dataSetId:
          description: Id of data set
          type: string
          readOnly: true
        dataSetType:
          description: Type of the data set
          enum:
          - Blob
          - Container
          - BlobFolder
          - AdlsGen2FileSystem
          - AdlsGen2Folder
          - AdlsGen2File
          - AdlsGen1Folder
          - AdlsGen1File
          - KustoCluster
          - KustoDatabase
          - SqlDBTable
          - SqlDWTable
          type: string
          readOnly: true
          x-ms-enum:
            name: dataSetType
            modelAsString: true
        durationMs:
          format: int32
          description: Duration of data set level copy
          type: integer
          readOnly: true
        endTime:
          format: date-time
          description: End time of data set level copy
          type: string
          readOnly: true
        filesRead:
          format: int64
          description: The number of files read from the source data set
          type: integer
          readOnly: true
        filesWritten:
          format: int64
          description: The number of files written into the sink data set
          type: integer
          readOnly: true
        message:
          description: Error message if any
          type: string
          readOnly: true
        name:
          description: Name of the data set
          type: string
          readOnly: true
        rowsCopied:
          format: int64
          description: The number of files copied into the sink data set
          type: integer
          readOnly: true
        rowsRead:
          format: int64
          description: The number of rows read from the source data set.
          type: integer
          readOnly: true
        sizeRead:
          format: int64
          description: The size of the data read from the source data set in bytes
          type: integer
          readOnly: true
        sizeWritten:
          format: int64
          description: The size of the data written into the sink data set in bytes
          type: integer
          readOnly: true
        startTime:
          format: date-time
          description: Start time of data set level copy
          type: string
          readOnly: true
        status:
          description: Raw Status
          type: string
          readOnly: true
        vCore:
          format: int64
          description: The vCore units consumed for the data set synchronization
          type: integer
          readOnly: true
    ShareSubscriptionProperties:
      description: Share subscription property bag.
      required:
      - invitationId
      type: object
      properties:
        createdAt:
          format: date-time
          description: Time at which the share subscription was created.
          type: string
          readOnly: true
        invitationId:
          description: The invitation id.
          type: string
        providerEmail:
          description: Email of the provider who created the resource
          type: string
          readOnly: true
        providerName:
          description: Name of the provider who created the resource
          type: string
          readOnly: true
        providerTenantName:
          description: Tenant name of the provider who created the resource
          type: string
          readOnly: true
        provisioningState:
          description: Provisioning state of the share subscription
          enum:
          - Succeeded
          - Creating
          - Deleting
          - Moving
          - Failed
          type: string
          readOnly: true
          x-ms-enum:
            name: provisioningState
            modelAsString: true
        shareDescription:
          description: Description of share
          type: string
          readOnly: true
        shareKind:
          description: Kind of share
          enum:
          - CopyBased
          - InPlace
          type: string
          readOnly: true
          x-ms-enum:
            name: shareKind
            modelAsString: true
        shareName:
          description: Name of the share
          type: string
          readOnly: true
        shareSubscriptionStatus:
          description: Gets the current status of share subscription.
          enum:
          - Active
          - Revoked
          - SourceDeleted
          - Revoking
          type: string
          readOnly: true
          x-ms-enum:
            name: shareSubscriptionStatus
            modelAsString: true
        shareTerms:
          description: Terms of a share
          type: string
          readOnly: 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
    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
    ConsumerSourceDataSetList:
      description: A consumer side list of source dataSets
      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: '#/components/schemas/ConsumerSourceDataSet'
    ConsumerSourceDataSetProperties:
      description: Properties of consumer source dataSet
      type: object
      properties:
        dataSetId:
          description: DataSet Id
          type: string
          readOnly: true
        dataSetLocation:
          description: Location of the data set.
          type: string
          readOnly: true
        dataSetName:
          description: DataSet name
          type: string
          readOnly: true
        dataSetPath:
          description: DataSet path
          type: string
          readOnly: true
        dataSetType:
          description: Type of data set
          enum:
          - Blob
          - Container
          - BlobFolder
          - AdlsGen2FileSystem
          - AdlsGen2Folder
          - AdlsGen2File
          - AdlsGen1Folder
          - AdlsGen1File
          - KustoCluster
          - KustoDatabase
          - SqlDBTable
          - SqlDWTable
          type: string
          readOnly: true
          x-ms-enum:
            name: dataSetType
            modelAsString: true
    OperationResponse:
      description: Response for long running operation
      required:
      - status
      type: object
      properties:
        endTime:
          format: date-time
          description: start time
          type: string
        error:
          $ref: '#/components/schemas/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
    ShareSubscriptionList:
      description: List response for get ShareSubscription.
      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: '#/components/schemas/ShareSubscription'
    SynchronizationDetailsList:
      description: details of synchronization
      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: '#/components/schemas/SynchronizationDetails'
    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: '#/components/schemas/DataShareErrorInfo'
        message:
          description: Message of the error
          type: string
        target:
          description: Target of the error
          type: string
    SourceShareSynchronizationSettingList:
      description: List response for get source share Synchronization settings
      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: '#/components/schemas/SourceShareSynchronizationSetting'
  parameters:
    accountName:
      name: accountName
      in: path
      description: The name of the share account.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    api-version:
      name: api-version
      in: query
      description: The api version to use.
      required: true
      schema:
        type: string
    subscriptionId:
      name: subscriptionId
      in: path
      description: The subscription identifier
      required: true
      schema:
        type: string
    resourceGroupName:
      name: resourceGroupName
      in: path
      description: The resource group 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: Azure Active Directory OAuth2 Flow.