Microsoft Azure Settings API

openapi: 3.2.0
info:
  title: Microsoft Azure CostManagementClient Settings API
  version: 2022-10-05-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Settings
paths:
  /{scope}/providers/Microsoft.CostManagement/settings:
    get:
      tags:
      - Settings
      operationId: microsoftAzureSettingsList
      description: List all cost management settings in the requested scope.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/cost-management/
      x-ms-examples:
        SettingsList:
          $ref: ./examples/settingsList.json
      parameters:
      - $ref: '#/components/parameters/scopeSettingParameter'
      - $ref: common-types.json#/parameters/apiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: common-types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Scope Providers Microsoft Costmanagement Settings
  /{scope}/providers/Microsoft.CostManagement/settings/{type}:
    put:
      tags:
      - Settings
      operationId: microsoftAzureSettingsCreateorupdatebyscope
      description: Create or update a setting within the given scope.
      x-ms-examples:
        CreateOrUpdateSettingByScope:
          $ref: ./examples/settings-createOrUpdate.json
      parameters:
      - $ref: '#/components/parameters/scopeSettingParameter'
      - $ref: '#/components/parameters/settingTypeParameter'
      - $ref: common-types.json#/parameters/apiVersionParameter
      responses:
        '200':
          description: Setting Updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
        '201':
          description: Setting Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: common-types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Scope Providers Microsoft Costmanagement Settings Type
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Setting'
        description: Setting to be created or updated.
        required: true
    get:
      tags:
      - Settings
      operationId: microsoftAzureSettingsGetbyscope
      description: Get the setting from the given scope by name.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/cost-management/
      x-ms-examples:
        SettingByScope:
          $ref: ./examples/setting-get.json
      parameters:
      - $ref: '#/components/parameters/scopeSettingParameter'
      - $ref: '#/components/parameters/settingTypeParameter'
      - $ref: common-types.json#/parameters/apiVersionParameter
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: common-types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Scope Providers Microsoft Costmanagement Settings Type
    delete:
      tags:
      - Settings
      operationId: microsoftAzureSettingsDeletebyscope
      description: Delete a setting within the given scope.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/cost-management/
      x-ms-examples:
        SettingDeleteByScope:
          $ref: ./examples/setting-delete.json
      parameters:
      - $ref: '#/components/parameters/scopeSettingParameter'
      - $ref: '#/components/parameters/settingTypeParameter'
      - $ref: common-types.json#/parameters/apiVersionParameter
      responses:
        '200':
          description: Setting deleted successfully.
        '204':
          description: Setting is already deleted or not found.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: common-types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Scope Providers Microsoft Costmanagement Settings Type
components:
  schemas:
    SettingsListResult:
      description: Setting list result. It contains a list of settings.
      type: object
      properties:
        value:
          description: The list of settings.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Setting'
    Setting:
      description: Setting definition.
      discriminator:
        propertyName: kind
      type: object
      allOf:
      - $ref: common-types.json#/definitions/ProxyResource
      properties:
        kind:
          type: string
          description: Specifies the kind of settings.
          enum:
          - taginheritance
          x-ms-enum:
            name: SettingsKind
            modelAsString: true
      required:
      - kind
  parameters:
    settingTypeParameter:
      name: type
      in: path
      description: Setting type.
      required: true
      x-ms-parameter-location: method
      x-ms-enum:
        name: SettingType
        modelAsString: true
        values:
        - value: taginheritance
          description: This setting applies resource group and subscription tags to usage data of child resources. Inherited tags will  be seen within 24 hours for the current month's usage data.
          name: TagInheritance
      schema:
        type: string
        enum:
        - taginheritance
    scopeSettingParameter:
      name: scope
      in: path
      required: true
      description: The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.
      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.