Microsoft Azure Connector API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Connector API
schemes:
- https
tags:
- name: Connector
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns
  : get:
      tags:
      - Connector
      operationId: microsoftAzureConnectorListdryrun
      description: list dryrun jobs
      x-ms-examples:
        ConnectorDryrunList:
          $ref: ./examples/ConnectorDryrunList.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DryrunList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Dryruns
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns/{dryrunName}
  : get:
      tags:
      - Connector
      operationId: microsoftAzureConnectorGetdryrun
      description: get a dryrun job
      x-ms-examples:
        ConnectorDryrunGet:
          $ref: ./examples/ConnectorDryrunGet.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: dryrunName
        in: path
        required: true
        type: string
        description: The name of dryrun.
        x-ms-parameter-location: method
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DryrunResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Dryruns Dryrunname
    put:
      tags:
      - Connector
      operationId: microsoftAzureConnectorCreatedryrun
      description: create a dryrun job to do necessary check before actual creation
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        ConnectorDryrunCreate:
          $ref: ./examples/ConnectorDryrunCreate.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: dryrunName
        in: path
        required: true
        type: string
        description: The name of dryrun.
        x-ms-parameter-location: method
      - name: parameters
        description: dryrun resource.
        in: body
        required: true
        schema:
          $ref: '#/definitions/DryrunResource'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DryrunResource'
        '201':
          description: Long running operation
          schema:
            $ref: '#/definitions/DryrunResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Dryruns Dryrunname
    patch:
      tags:
      - Connector
      operationId: microsoftAzureConnectorUpdatedryrun
      description: update a dryrun job to do necessary check before actual creation
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        ConnectorDryrunUpdate:
          $ref: ./examples/ConnectorDryrunUpdate.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: dryrunName
        in: path
        required: true
        type: string
        description: The name of dryrun.
        x-ms-parameter-location: method
      - name: parameters
        description: dryrun resource.
        in: body
        required: true
        schema:
          $ref: '#/definitions/DryrunPatch'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/DryrunResource'
        '202':
          description: Accepted - Returns this status until the asynchronous operation has completed.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Dryruns Dryrunname
    delete:
      tags:
      - Connector
      operationId: microsoftAzureConnectorDeletedryrun
      description: delete a dryrun job
      x-ms-examples:
        ConnectorDryrunDelete:
          $ref: ./examples/ConnectorDryrunDelete.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: dryrunName
        in: path
        required: true
        type: string
        description: The name of dryrun.
        x-ms-parameter-location: method
      responses:
        '200':
          description: OK. The job is deleted.
        '204':
          description: Deleted. The job is not found.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Dryruns Dryrunname
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}
  : delete:
      tags:
      - Connector
      operationId: microsoftAzureConnectorDelete
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      description: Delete a Connector.
      x-ms-examples:
        DeleteConnector:
          $ref: ./examples/DeleteConnector.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: '#/parameters/ConnectorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The Connector is deleted.
        '202':
          description: Long running operation.
        '204':
          description: Deleted. The Connector is not found.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors Connectorname
    patch:
      tags:
      - Connector
      operationId: microsoftAzureConnectorUpdate
      description: Operation to update an existing Connector.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        PatchConnector:
          $ref: ./examples/PatchConnector.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: '#/parameters/ConnectorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: parameters
        description: Connector details.
        in: body
        required: true
        schema:
          $ref: '#/definitions/LinkerPatch'
      responses:
        '200':
          description: Success. The response describes a Connector.
          schema:
            $ref: '#/definitions/LinkerResource'
        '202':
          description: Long running operation.
          schema:
            $ref: '#/definitions/LinkerResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors Connectorname
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/validate
  : post:
      tags:
      - Connector
      operationId: microsoftAzureConnectorValidate
      description: Validate a Connector.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        ValidateConnectorSuccess:
          $ref: ./examples/ValidateConnectorSuccess.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: '#/parameters/ConnectorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ValidateOperationResult'
        '202':
          description: Accepted - Returns this status until the asynchronous operation has completed.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors Connectorname Validate
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/generateConfigurations
  : post:
      tags:
      - Connector
      operationId: microsoftAzureConnectorGenerateconfigurations
      description: Generate configurations for a Connector.
      x-ms-examples:
        GenerateConfiguration:
          $ref: ./examples/GenerateConfigurations.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter
      - $ref: '#/parameters/ConnectorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: parameters
        description: Connection Info, including format, secret store, etc
        in: body
        required: false
        schema:
          $ref: '#/definitions/ConfigurationInfo'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ConfigurationResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors Connectorname Generateconfigurations
definitions:
  SecretStore:
    type: object
    description: An option to store secret value in secure place
    properties:
      keyVaultId:
        x-nullable: true
        type: string
        description: The key vault id to store secret
      keyVaultSecretName:
        x-nullable: true
        type: string
        description: The key vault secret name to store secret, only valid when storing one secret
  LinkerResource:
    type: object
    description: Linker of source and target resource
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
      description: The resource model definition for an Azure Resource Manager proxy resource.
    required:
    - properties
    properties:
      properties:
        description: The properties of the Linker.
        $ref: '#/definitions/LinkerProperties'
        x-ms-client-flatten: true
      systemData:
        x-nullable: true
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData
        description: The system data.
  ValidationResultItem:
    description: The validation item for a Linker.
    type: object
    properties:
      name:
        description: The validation item name.
        type: string
      description:
        x-nullable: true
        description: The display name of validation item
        type: string
      result:
        x-nullable: true
        description: The result of validation
        type: string
        enum:
        - success
        - failure
        - warning
        x-ms-enum:
          name: ValidationResultStatus
          modelAsString: true
      errorMessage:
        x-nullable: true
        description: The error message of validation result
        type: string
      errorCode:
        x-nullable: true
        description: The error code of validation result
        type: string
  AuthType:
    description: The authentication type.
    type: string
    enum:
    - systemAssignedIdentity
    - userAssignedIdentity
    - servicePrincipalSecret
    - servicePrincipalCertificate
    - secret
    - accessKey
    - userAccount
    - easyAuthMicrosoftEntraID
    x-ms-enum:
      name: AuthType
      modelAsString: true
  DryrunProperties:
    description: The properties of the dryrun job
    type: object
    properties:
      parameters:
        description: The parameters of the dryrun
        $ref: '#/definitions/DryrunParameters'
      prerequisiteResults:
        readOnly: true
        description: the result of the dryrun
        type: array
        items:
          $ref: '#/definitions/DryrunPrerequisiteResult'
        x-ms-identifiers: []
      operationPreviews:
        readOnly: true
        description: the preview of the operations for creation
        type: array
        items:
          $ref: '#/definitions/DryrunOperationPreview'
        x-ms-identifiers: []
      provisioningState:
        readOnly: true
        type: string
        description: 'The provisioning state. '
  DryrunActionName:
    description: The name of action for you dryrun job.
    type: string
    enum:
    - createOrUpdate
    x-ms-enum:
      name: DryrunActionName
      modelAsString: true
  DaprProperties:
    type: object
    description: Indicates some additional properties for dapr client type
    properties:
      version:
        x-nullable: true
        type: string
        description: The dapr component version
      componentType:
        x-nullable: true
        type: string
        description: The dapr component type
      secretStoreComponent:
        x-nullable: true
        type: string
        description: The name of a secret store dapr to retrieve secret
      metadata:
        description: Additional dapr metadata
        type: array
        items:
          $ref: '#/definitions/DaprMetadata'
        x-ms-identifiers:
        - name
      scopes:
        description: The dapr component scopes
        type: array
        items:
          type: string
      runtimeVersion:
        x-nullable: true
        type: string
        readOnly: true
        description: The runtime version supported by the properties
      bindingComponentDirection:
        x-nullable: true
        type: string
        enum:
        - input
        - output
        x-ms-enum:
          name: DaprBindingComponentDirection
          modelAsString: true
        readOnly: true
        description: The direction supported by the dapr binding component
  ConfigurationStore:
    type: object
    description: An option to store configuration into different place
    properties:
      appConfigurationId:
        x-nullable: true
        type: string
        description: The app configuration id to store configuration
  ValidateOperationResult:
    description: The validation operation result for a Linker.
    type: object
    properties:
      properties:
        x-nullable: true
        description: The validation result detail.
        x-ms-client-flatten: true
        $ref: '#/definitions/ValidateResult'
      resourceId:
        x-nullable: true
        description: Validated Linker id.
        type: string
      status:
        x-nullable: true
        description: Validation operation status.
        type: string
  DryrunParameters:
    description: The parameters of the dryrun
    discriminator: actionName
    type: object
    properties:
      actionName:
        $ref: '#/definitions/DryrunActionName'
    required:
    - actionName
  ConfigurationResult:
    description: Configurations for source resource, include appSettings, connectionString and serviceBindings
    type: object
    properties:
      configurations:
        description: The configuration properties for source resource.
        type: array
        items:
          $ref: '#/definitions/SourceConfiguration'
        x-ms-identifiers:
        - name
  ClientType:
    description: The application client type
    type: string
    enum:
    - none
    - dotnet
    - java
    - python
    - go
    - php
    - ruby
    - django
    - nodejs
    - springBoot
    - kafka-springBoot
    - jms-springBoot
    - dapr
    x-ms-enum:
      name: clientType
      modelAsString: true
  AuthInfoBase:
    description: The authentication info
    discriminator: authType
    type: object
    properties:
      authType:
        description: The authentication type.
        $ref: '#/definitions/AuthType'
      authMode:
        description: Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.
        $ref: '#/definitions/AuthMode'
    required:
    - authType
  FirewallRules:
    type: object
    description: Target service's firewall rules. to allow connections from source service.
    properties:
      ipRanges:
        type: array
        items:
          type: string
        description: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account.
      azureServices:
        description: Allow Azure services to access the target service if true.
        $ref: '#/definitions/AllowType'
      callerClientIP:
        description: Allow caller client IP to access the target service if true. the property is used when connecting local application to target service.
        $ref: '#/definitions/AllowType'
  DryrunList:
    description: The list of dryrun.
    type: object
    properties:
      nextLink:
        x-nullable: true
        description: The link used to get the next page of dryrun list.
        type: string
      value:
        description: The list of dryrun.
        type: array
        items:
          $ref: '#/definitions/DryrunResource'
  ConfigurationInfo:
    type: object
    description: The configuration information, used to generate configurations or save to applications
    properties:
      deleteOrUpdateBehavior:
        description: Indicates whether to clean up previous operation when Linker is updating or deleting
        $ref: '#/definitions/DeleteOrUpdateBehavior'
      action:
        description: Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source.
        $ref: '#/definitions/ActionType'
      customizedKeys:
        description: Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations
        type: object
        additionalProperties:
          type: string
      daprProperties:
        description: Indicates some additional properties for dapr client type
        $ref: '#/definitions/DaprProperties'
      additionalConfigurations:
        description: A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations
        type: object
        additionalProperties:
          type: string
      additionalConnectionStringProperties:
        description: A dictionary of additional properties to be added in the end of connection string.
        type: object
        additionalProperties:
          type: string
      configurationStore:
        x-nullable: true
        description: An option to store configuration into different place
        $ref: '#/definitions/ConfigurationStore'
  PublicNetworkSolution:
    type: object
    description: Indicates public network solution, include firewall rules
    properties:
      deleteOrUpdateBehavior:
        description: Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting
        $ref: '#/definitions/DeleteOrUpdateBehavior'
      action:
        description: Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.
        $ref: '#/definitions/ActionType'
      firewallRules:
        description: Describe firewall rules of target service to make sure source application could connect to the target.
        $ref: '#/definitions/FirewallRules'
  DryrunPatch:
    type: object
    description: a dryrun job to be updated.
    properties:
      properties:
        description: The properties of the dryrun job.
        $ref: '#/definitions/DryrunProperties'
        x-ms-client-flatten: true
  DryrunResource:
    type: object
    description: a dryrun job resource
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
      description: The resource model definition for an Azure Resource Manager proxy resource.
    properties:
      properties:
        description: The properties of the dryrun job.
        $ref: '#/definitions/DryrunProperties'
        x-ms-client-flatten: true
  DryrunPrerequisiteResultType:
    description: The type of dryrun result.
    type: string
    enum:
    - basicError
    - permissionsMissing
    x-ms-enum:
      name: DryrunPrerequisiteResultType
      modelAsString: true
  TargetServiceType:
    description: The target service type.
    type: string
    enum:
    - AzureResource
    - ConfluentBootstrapServer
    - ConfluentSchemaRegistry
    - SelfHostedServer
    x-ms-enum:
      name: targetServiceType
      modelAsString: true
  ValidateResult:
    description: The validation result for a Linker.
    type: object
    properties:
      linkerName:
        x-nullable: true
        description: The linker name.
        type: string
      isConnectionAvailable:
        x-nullable: true
        description: A boolean value indicating whether the connection is available or not
        type: boolean
      reportStartTimeUtc:
        x-nullable: true
        type: string
        format: date-time
        description: The start time of the validation report.
      reportEndTimeUtc:
        x-nullable: true
        type: string
        format: date-time
        description: The end time of the validation report.
      sourceId:
        x-nullable: true
        description: The resource id of the Linker source application.
        type: string
      targetId:
        x-nullable: true
        description: The resource Id of target service.
        type: string
      authType:
        x-nullable: true
        description: The authentication type.
        $ref: '#/definitions/AuthType'
      validationDetail:
        description: The detail of validation result
        type: array
        items:
          $ref: '#/definitions/ValidationResultItem'
        x-ms-identifiers:
        - name
  DaprMetadata:
    description: The dapr component metadata.
    type: object
    properties:
      name:
        description: Metadata property name.
        type: string
      value:
        description: Metadata property value.
        type: string
      secretRef:
        description: The secret name where dapr could get value
        type: string
      description:
        description: The description of the metadata, returned from configuration api
        type: string
      required:
        description: The value indicating whether the metadata is required or not
        type: string
        enum:
        - 'true'
        - 'false'
        x-ms-enum:
          name: DaprMetadataRequired
          modelAsString: true
  VNetSolution:
    type: object
    description: The VNet solution for linker
    properties:
      type:
        x-nullable: true
        description: Type of VNet solution.
        type: string
        enum:
        - serviceEndpoint
        - privateLink
        x-ms-enum:
          name: vNetSolutionType
          modelAsString: true
      deleteOrUpdateBehavior:
        description: Indicates whether to clean up previous operation when Linker is updating or deleting
        $ref: '#/definitions/DeleteOrUpdateBehavior'
  LinkerConfigurationType:
    description: Type of configuration to determine whether the configuration can be modified after creation. KeyvaultSecret means the configuration references a key vault secret, such as App Service/ACA key vault reference. Default means the configuration is real value, such as user name, raw secret, etc.
    type: string
    enum:
    - Default
    - KeyVaultSecret
    x-ms-enum:
      name: LinkerConfigurationType
      modelAsString: true
  ActionType:
    description: Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration.
    type: string
    enum:
    - enable
    - optOut
    x-ms-enum:
      name: actionType
      modelAsString: true
  DryrunOperationPreview:
    description: The preview of the operations for creation
    type: object
    properties:
      name:
        description: The operation name
        type: string
      operationType:
        description: The operation type
        type: string
        enum:
        - configConnection
        - configNetwork
        - configAuth
        x-ms-enum:
          name: DryrunPreviewOperationType
          modelAsString: true
      description:
        description: The description of the operation
        type: string
      action:
        description: The action defined by RBAC, refer https://docs.microsoft.com/azure/role-based-access-control/role-definitions#actions-format
        type: string
      scope:
        description: The scope of the operation, refer https://docs.microsoft.com/azure/role-based-access-control/scope-overview
        type: string
  LinkerProperties:
    description: The properties of the Linker.
    type: object
    properties:
      targetService:
        $ref: '#/definitions/TargetServiceBase'
        description: The target service properties
      authInfo:
        description: The authentication type.
        $ref: '#/definitions/AuthInfoBase'
      clientType:
        description: The application client type
        $ref: '#/definitions/ClientType'
      provisioningState:
        readOnly: true
        type: string
        description: 'The provisioning state. '
      vNetSolution:
        x-nullable: true
        description: The VNet solution.
        $ref: '#/definitions/VNetSolution'
      secretStore:
        x-nullable: true
        description: An option to store secret value in secure place
        $ref: '#/definitions/SecretStore'
      scope:
        x-nullable: true
        type: string
        description: connection scope in source service.
      publicNetworkSolution:
        x-nullable: true
        description: The network solution.
        $ref: '#/definitions/PublicNetworkSolution'
      configurationInfo:
        x-nullable: true
        description: The connection information consumed by applications, including secrets, connection strings.
        $ref: '#/definitions/ConfigurationInfo'
  AllowType:
    description: Whether to allow firewall rules.
    type: string
    enum:
    - 'true'
    - 'false'
    x-ms-enum:
      name: allowType
      modelAsString: true
  DeleteOrUpdateBehavior:
    description: The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
    type: string
    enum:
    - Default
    - ForcedCleanup
    x-ms-enum:
      name: DeleteOrUpdateBehavior
      modelAsString: true
  TargetServiceBase:
    description: The target service properties
    discriminator: type
    type: object
    properties:
      type:
        description: The target service type.
        $ref: '#/definitions/TargetServiceType'
    required:
    - type
  AuthMode:
    description: Indicates how to apply the authentication configuration operations.
    type: string
    enum:
    - optInAllAuth
    - optOutAllAuth
    x-ms-enum:
      name: authMode
      modelAsString: true
      values:
      - value: optInAllAuth
        description: Default authentication configuration according to the authenticat

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-connector-api-openapi.yml