swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NspAssociations API
schemes:
- https
tags:
- name: NspAssociations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations/{associationName}
  : parameters:
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/NetworkSecurityPerimeterNameParameter'
    - $ref: '#/parameters/AssociationNameParameter'
    - $ref: ./network.json#/parameters/ApiVersionParameter
    get:
      tags:
      - NspAssociations
      operationId: microsoftAzureNspassociationsGet
      description: Gets the specified NSP association by name.
      responses:
        '200':
          description: OK - Returns information about the NSP resource association.
          schema:
            $ref: '#/definitions/NspAssociation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspAssociationGet:
          $ref: ./examples/NspAssociationGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Resourceassociations Associationname
    put:
      tags:
      - NspAssociations
      operationId: microsoftAzureNspassociationsCreateorupdate
      description: Creates or updates a NSP resource association.
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/NspAssociation'
        description: Parameters that hold the NspAssociation resource to be created/updated.
      responses:
        '200':
          description: Updated - Existing resource association is updated. Returns the resource.
          schema:
            $ref: '#/definitions/NspAssociation'
        '201':
          description: Create - Returns the NspAssociation resource created.
          schema:
            $ref: '#/definitions/NspAssociation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspAssociationPut:
          $ref: ./examples/NspAssociationPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Resourceassociations Associationname
    delete:
      tags:
      - NspAssociations
      operationId: microsoftAzureNspassociationsDelete
      description: Deletes an NSP association resource.
      responses:
        '200':
          description: Delete Succeed.
        '202':
          description: Delete in progress.
          headers:
            location:
              description: location header
              type: string
        '204':
          description: Request successful. The resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-examples:
        NspAssociationDelete:
          $ref: ./examples/NspAssociationDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Resourceassociations Associationname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations
  : get:
      tags:
      - NspAssociations
      operationId: microsoftAzureNspassociationsList
      description: Lists the NSP resource associations.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/NetworkSecurityPerimeterNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ListTopParameter'
      - $ref: '#/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: OK - Returns the list of NSP resource associations.
          schema:
            $ref: '#/definitions/NspAssociationsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspAssociationList:
          $ref: ./examples/NspAssociationList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Resourceassociations
definitions:
  NspAssociationsListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NspAssociation'
        description: Gets a page of NSP resource associations
      nextLink:
        type: string
        description: Gets the URL to get the next page of results.
    description: Result of the request to list NSP resource associations. Contains a list of NSP resource associations and a URL link to get the next set of results.
  NSPProvisioningState:
    type: string
    readOnly: true
    description: The current provisioning state.
    enum:
    - Succeeded
    - Creating
    - Updating
    - Deleting
    - Accepted
    - Failed
    x-ms-enum:
      name: nspProvisioningState
      modelAsString: true
  NspAssociationProperties:
    type: object
    properties:
      provisioningState:
        readOnly: true
        $ref: '#/definitions/NSPProvisioningState'
        description: The provisioning state of the resource  association resource.
      privateLinkResource:
        $ref: ./network.json#/definitions/SubResource
        description: The PaaS resource to be associated.
      profile:
        $ref: ./network.json#/definitions/SubResource
        description: Profile id to which the PaaS resource is associated.
      accessMode:
        type: string
        enum:
        - Learning
        - Enforced
        - Audit
        x-ms-enum:
          name: AssociationAccessMode
          modelAsString: true
        description: Access mode on the association.
      hasProvisioningIssues:
        readOnly: true
        type: string
        description: Specifies if there are provisioning issues
  NspAssociation:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NspAssociationProperties'
        description: Properties of the NSP resource association.
      name:
        type: string
        description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
      id:
        readOnly: true
        type: string
        description: NSP resource association identifier.
      type:
        readOnly: true
        type: string
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/Resource
    description: The NSP resource association resource
parameters:
  AssociationNameParameter:
    name: associationName
    in: path
    required: true
    type: string
    description: The name of the NSP association.
    x-ms-parameter-location: method
  ListTopParameter:
    name: $top
    description: An optional query parameter which specifies the maximum number of records to be returned by the server.
    in: query
    required: false
    type: integer
    format: int32
    minimum: 1
    maximum: 20
    x-ms-parameter-location: method
  NetworkSecurityPerimeterNameParameter:
    name: networkSecurityPerimeterName
    in: path
    required: true
    type: string
    description: The name of the network security perimeter.
    x-ms-parameter-location: method
  ListSkipTokenParameter:
    name: $skipToken
    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.
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'