Microsoft Azure SourceControlConfiguration API

openapi: 3.2.0
info:
  version: 2022-01-01-preview
  title: Microsoft Azure SourceControlConfigurationClient Source…
  description: Use these APIs to create Source Control Configuration resources through ARM, for Kubernetes Clusters.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: SourceControlConfiguration
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/sourceControlConfigurations/{sourceControlConfigurationName}
  : get:
      tags:
      - SourceControlConfiguration
      description: Gets details of the Source Control Configuration.
      operationId: microsoftAzureSourcecontrolconfigurationsGet
      x-ms-examples:
        Get Source Control Configuration:
          $ref: ./examples/GetSourceControlConfiguration.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/SourceControlConfigurationNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlConfiguration'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - SourceControlConfiguration
      description: Create a new Kubernetes Source Control Configuration.
      operationId: microsoftAzureSourcecontrolconfigurationsCreateorupdate
      x-ms-examples:
        Create Source Control Configuration:
          $ref: ./examples/CreateSourceControlConfiguration.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/SourceControlConfigurationNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlConfiguration'
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlConfiguration'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceControlConfiguration'
        description: Properties necessary to Create KubernetesConfiguration.
        required: true
    delete:
      tags:
      - SourceControlConfiguration
      description: This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.
      operationId: microsoftAzureSourcecontrolconfigurationsDelete
      x-ms-examples:
        Delete Source Control Configuration:
          $ref: ./examples/DeleteSourceControlConfiguration.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/SourceControlConfigurationNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK.  The request has been completed successfully.
        '204':
          description: No Content.  The request has been accepted but the configuration was not found.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/sourceControlConfigurations
  : get:
      tags:
      - SourceControlConfiguration
      description: List all Source Control Configurations.
      operationId: microsoftAzureSourcecontrolconfigurationsList
      x-ms-examples:
        List Source Control Configuration:
          $ref: ./examples/ListSourceControlConfiguration.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter
      - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlConfigurationList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    HelmOperatorProperties:
      description: Properties for Helm operator.
      type: object
      properties:
        chartVersion:
          description: Version of the operator Helm chart.
          $ref: '#/components/schemas/ChartVersion'
        chartValues:
          description: Values override for the operator Helm chart.
          $ref: '#/components/schemas/ChartValues'
    SourceControlConfigurationList:
      description: Result of the request to list Source Control Configurations.  It contains a list of SourceControlConfiguration objects and a URL link to get the next set of results.
      type: object
      properties:
        value:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/SourceControlConfiguration'
          description: List of Source Control Configurations within a Kubernetes cluster.
        nextLink:
          type: string
          readOnly: true
          description: URL to get the next set of configuration objects, if any.
    ChartValues:
      description: Values override for the operator Helm chart.
      type: string
    ComplianceStatus:
      description: Compliance Status details
      type: object
      readOnly: true
      properties:
        complianceState:
          description: The compliance state of the configuration.
          type: string
          readOnly: true
          x-ms-enum:
            name: ComplianceStateType
            modelAsString: true
          enum:
          - Pending
          - Compliant
          - Noncompliant
          - Installed
          - Failed
        lastConfigApplied:
          description: Datetime the configuration was last applied.
          type: string
          format: date-time
        message:
          description: Message from when the configuration was applied.
          type: string
        messageLevel:
          description: Level of the message.
          type: string
          enum:
          - Error
          - Warning
          - Information
          x-ms-enum:
            name: MessageLevelType
            modelAsString: true
    ConfigurationProtectedSettings:
      description: Name-value pairs of protected configuration settings for the configuration
      type: object
      additionalProperties:
        type: string
    SourceControlConfiguration:
      description: The SourceControl Configuration object returned in Get & Put response.
      type: object
      properties:
        properties:
          type: object
          x-ms-client-flatten: true
          description: Properties to create a Source Control Configuration resource
          properties:
            repositoryUrl:
              type: string
              description: Url of the SourceControl Repository.
            operatorNamespace:
              description: The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only.
              type: string
              default: default
            operatorInstanceName:
              description: Instance name of the operator - identifying the specific configuration.
              type: string
            operatorType:
              description: Type of the operator
              $ref: '#/components/schemas/OperatorTypeDefinition'
            operatorParams:
              description: Any Parameters for the Operator instance in string format.
              type: string
            configurationProtectedSettings:
              description: Name-value pairs of protected configuration settings for the configuration
              type: object
              $ref: '#/components/schemas/ConfigurationProtectedSettings'
            operatorScope:
              description: Scope at which the operator will be installed.
              $ref: '#/components/schemas/OperatorScopeDefinition'
            repositoryPublicKey:
              description: Public Key associated with this SourceControl configuration (either generated within the cluster or provided by the user).
              type: string
              readOnly: true
            sshKnownHostsContents:
              description: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances
              type: string
            enableHelmOperator:
              description: Option to enable Helm Operator for this git configuration.
              type: boolean
            helmOperatorProperties:
              description: Properties for Helm operator.
              type: object
              $ref: '#/components/schemas/HelmOperatorProperties'
            provisioningState:
              type: string
              description: The provisioning state of the resource provider.
              readOnly: true
              x-ms-enum:
                modelAsString: true
                name: ProvisioningStateType
              enum:
              - Accepted
              - Deleting
              - Running
              - Succeeded
              - Failed
            complianceStatus:
              type: object
              description: Compliance Status of the Configuration
              readOnly: true
              $ref: '#/components/schemas/ComplianceStatus'
        systemData:
          description: Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      allOf:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    OperatorScopeDefinition:
      description: Scope at which the operator will be installed.
      type: string
      enum:
      - cluster
      - namespace
      default: cluster
      x-ms-enum:
        name: OperatorScopeType
        modelAsString: true
    ChartVersion:
      description: Version of the operator Helm chart.
      type: string
    OperatorTypeDefinition:
      description: Type of the operator
      type: string
      enum:
      - Flux
      x-ms-enum:
        name: OperatorType
        modelAsString: true
  parameters:
    SourceControlConfigurationNameParameter:
      name: sourceControlConfigurationName
      in: path
      description: Name of the Source Control Configuration.
      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