swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GuestDiagnosticsSettings API
schemes:
- https
tags:
- name: GuestDiagnosticsSettings
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettings/{diagnosticSettingsName}
  : put:
      description: Creates or updates guest diagnostics settings.
      tags:
      - GuestDiagnosticsSettings
      operationId: microsoftAzureGuestdiagnosticssettingsCreateorupdate
      x-ms-examples:
        Create or update a guest diagnostic settings:
          $ref: ./examples/createOrUpdateGuestDiagnosticSettings.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DiagnosticSettingNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - name: diagnosticSettings
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuestDiagnosticSettingsResource'
        description: The configuration to create or update.
      responses:
        '200':
          description: An existing guest diagnostic settings was successfully updated.
          schema:
            $ref: '#/definitions/GuestDiagnosticSettingsResource'
        '201':
          description: A new guest diagnostic settings was successfully created.
          schema:
            $ref: '#/definitions/GuestDiagnosticSettingsResource'
        default:
          description: An error occurred and the guest diagnostic settings could not be created or updated.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Guestdiagnosticsettings Diagnosticsettingsname
    get:
      description: Gets guest diagnostics settings.
      tags:
      - GuestDiagnosticsSettings
      operationId: microsoftAzureGuestdiagnosticssettingsGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DiagnosticSettingNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request succeeded.
          schema:
            $ref: '#/definitions/GuestDiagnosticSettingsResource'
        default:
          description: An error occurred and the diagnostic settings could not be retrieved.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Guestdiagnosticsettings Diagnosticsettingsname
    delete:
      description: Delete guest diagnostics settings.
      tags:
      - GuestDiagnosticsSettings
      operationId: microsoftAzureGuestdiagnosticssettingsDelete
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DiagnosticSettingNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The diagnostic settings was successfully deleted.
        '204':
          description: The diagnostic settings does not exist. It may have already been deleted.
        default:
          description: An error occurred and the diagnostic settings could not be deleted.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Guestdiagnosticsettings Diagnosticsettingsname
definitions:
  ErrorResponse:
    description: Describes the format of Error response.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  DataSourceConfiguration:
    type: object
    properties:
      providers:
        type: array
        items:
          $ref: '#/definitions/EtwProviderConfiguration'
        description: ETW providers configuration
      perfCounters:
        type: array
        items:
          $ref: '#/definitions/PerformanceCounterConfiguration'
        description: Performance counter configuration
      eventLogs:
        type: array
        items:
          $ref: '#/definitions/EventLogConfiguration'
        description: Windows event logs configuration.
  EventLogConfiguration:
    type: object
    required:
    - logName
    properties:
      logName:
        type: string
      filter:
        type: string
  Resource:
    properties:
      id:
        type: string
        readOnly: true
        description: Azure resource Id
      name:
        type: string
        readOnly: true
        description: Azure resource name
      type:
        type: string
        readOnly: true
        description: Azure resource type
      location:
        type: string
        description: Resource location
        x-ms-mutability:
        - create
        - read
      tags:
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
    description: An azure resource object
  SinkConfiguration:
    type: object
    required:
    - kind
    properties:
      kind:
        type: string
        enum:
        - EventHub
        - ApplicationInsights
        - LogAnalytics
  EtwProviderConfiguration:
    type: object
    required:
    - id
    - events
    properties:
      id:
        type: string
      events:
        type: array
        items:
          $ref: '#/definitions/EtwEventConfiguration'
  DataSource:
    type: object
    required:
    - kind
    - configuration
    - sinks
    properties:
      kind:
        type: string
        enum:
        - PerformanceCounter
        - ETWProviders
        - WindowsEventLogs
        description: Datasource kind
      configuration:
        type: object
        $ref: '#/definitions/DataSourceConfiguration'
      sinks:
        type: array
        items:
          $ref: '#/definitions/SinkConfiguration'
    description: Data source object contains configuration to collect telemetry and one or more sinks to send that telemetry data to
  EtwEventConfiguration:
    type: object
    required:
    - name
    - id
    properties:
      name:
        type: string
      id:
        type: integer
      filter:
        type: string
  GuestDiagnosticSettings:
    description: Virtual machine diagnostic settings
    properties:
      osType:
        type: string
        enum:
        - Windows
        - Linux
        description: Operating system type for the configuration
      dataSources:
        type: array
        items:
          $ref: '#/definitions/DataSource'
        description: the array of data source object which are configured to collect and send data
      proxySetting:
        type: string
  PerformanceCounterConfiguration:
    type: object
    required:
    - name
    - samplingPeriod
    properties:
      name:
        type: string
      samplingPeriod:
        type: string
      instance:
        type: string
  GuestDiagnosticSettingsResource:
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GuestDiagnosticSettings'
        description: The diagnostic settings to be applied to azure resources.
    description: Virtual machine guest diagnostics settings resource.
parameters:
  DiagnosticSettingNameParameter:
    name: diagnosticSettingsName
    in: path
    required: true
    type: string
    description: The name of the diagnostic setting.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'