Azure Networking Services Commits API

openapi: 3.2.0
info:
  title: WebApplicationFirewallManagement Commits API
  version: '2026-03-01'
  description: APIs to manage Microsoft Azure network resources.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Commits
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/commits
  : get:
      operationId: Commits_List
      tags:
      - Commits
      description: Lists all commits for the specified network manager.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: networkManagerName
        in: path
        description: The name of the network manager.
        required: true
        schema:
          type: string
          pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$
      - name: $top
        in: query
        description: An optional query parameter which specifies the maximum number of records to be returned by the server.
        required: false
        schema:
          type: integer
          format: int32
          maximum: 20
          minimum: 1
      - name: $skipToken
        in: query
        description: SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Commits list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/commits/{commitName}
  : get:
      operationId: Commits_Get
      tags:
      - Commits
      description: Gets the specified commit.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: networkManagerName
        in: path
        description: The name of the network manager.
        required: true
        schema:
          type: string
          pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$
      - name: commitName
        in: path
        description: The name of the commit.
        required: true
        schema:
          type: string
          pattern: ^(?![.-])[a-zA-Z0-9_.-]{1,128}$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Commit'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Commits get
      x-summary-source: derived
    put:
      operationId: Commits_CreateOrUpdate
      tags:
      - Commits
      description: Creates or updates a commit.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: networkManagerName
        in: path
        description: The name of the network manager.
        required: true
        schema:
          type: string
          pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$
      - name: commitName
        in: path
        description: The name of the commit.
        required: true
        schema:
          type: string
          pattern: ^(?![.-])[a-zA-Z0-9_.-]{1,128}$
      responses:
        '200':
          description: Resource 'Commit' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Commit'
        '201':
          description: Resource 'Commit' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Commit'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/Commit'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Commit'
        description: Parameters supplied to specify which commit to create
        required: true
      summary: Commits create or update
      x-summary-source: derived
    delete:
      operationId: Commits_Delete
      tags:
      - Commits
      description: Deletes a commit.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: networkManagerName
        in: path
        description: The name of the network manager.
        required: true
        schema:
          type: string
          pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$
      - name: commitName
        in: path
        description: The name of the commit.
        required: true
        schema:
          type: string
          pattern: ^(?![.-])[a-zA-Z0-9_.-]{1,128}$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Commits delete
      x-summary-source: derived
components:
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  schemas:
    systemData:
      type: object
      description: Metadata pertaining to creation and last modification of the resource.
      properties:
        createdBy:
          type: string
          description: The identity that created the resource.
        createdByType:
          type: string
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC).
        lastModifiedBy:
          type: string
          description: The identity that last modified the resource.
        lastModifiedByType:
          type: string
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
      readOnly: true
    ConfigurationType:
      type: string
      description: Configuration Deployment Type.
      enum:
      - SecurityAdmin
      - Connectivity
      - SecurityUser
      - Routing
      x-ms-enum:
        name: ConfigurationType
        modelAsString: true
        values:
        - name: SecurityAdmin
          value: SecurityAdmin
          description: SecurityAdmin
        - name: Connectivity
          value: Connectivity
          description: Connectivity
        - name: SecurityUser
          value: SecurityUser
          description: SecurityUser
        - name: Routing
          value: Routing
          description: Routing
    Commit:
      type: object
      description: The commit resource
      properties:
        properties:
          $ref: '#/components/schemas/CommitProperties'
          description: The Commit properties
        systemData:
          $ref: '#/components/schemas/systemData'
          description: The system metadata related to this resource.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/ChildResource'
    ChildResource:
      type: object
      description: Proxy resource representation.
      properties:
        id:
          type: string
          description: Resource ID.
          readOnly: true
        name:
          type: string
          description: Resource name.
          readOnly: true
        type:
          type: string
          description: Resource type.
          readOnly: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      x-ms-azure-resource: true
    CommitListResult:
      type: object
      description: The response of a Commit list operation.
      properties:
        value:
          type: array
          description: The Commit items on this page
          items:
            $ref: '#/components/schemas/Commit'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ProvisioningState:
      type: string
      description: Provisioning states of a resource.
      enum:
      - Failed
      - Succeeded
      - Canceled
      - Creating
      - Updating
      - Deleting
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Failed
          value: Failed
          description: Failed
        - name: Succeeded
          value: Succeeded
          description: Succeeded
        - name: Canceled
          value: Canceled
          description: Canceled
        - name: Creating
          value: Creating
          description: Creating
        - name: Updating
          value: Updating
          description: Updating
        - name: Deleting
          value: Deleting
          description: Deleting
    CommitProperties:
      type: object
      description: Properties of commit
      properties:
        description:
          type: string
          description: A description of the commit.
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state of the resource.
          readOnly: true
        resourceGuid:
          type: string
          description: Unique identifier for this resource.
          readOnly: true
        commitType:
          $ref: '#/components/schemas/ConfigurationType'
          description: Commit Type.
        configurationIds:
          type: array
          description: List of configuration IDs.
          items:
            type: string
            format: arm-id
            description: A type definition that refers the id to an Azure Resource Manager resource.
        targetLocations:
          type: array
          description: List of target locations.
          items:
            type: string
        activeLocations:
          type: array
          description: List of active locations.
          items:
            type: string
          readOnly: true
        forceUpdateTag:
          type: string
          description: A value that, when changed, forces the commit to be re-evaluated and redeployed.
      required:
      - commitType
      - targetLocations
    CloudError:
      type: object
      description: An error response from the service.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Cloud error body.
      x-ms-external: true
  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.