Microsoft Azure ManagementZones API

openapi: 3.2.0
info:
  title: Microsoft Azure Management Zones API
  version: '1.0'
  description: 'Operations tagged ManagementZones across 2 of this provider''s published API definitions: azure-agfoodplatform-data-plane-service-openapi-original.yml, microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml. Each path carries the servers of the definition it was published in.'
security:
- Bearer: []
tags:
- name: ManagementZones
paths:
  /management-zones:
    get:
      tags:
      - ManagementZones
      description: Returns a paginated list of management zone resources across all parties.
      operationId: microsoftAzureManagementzonesList
      parameters:
      - in: query
        name: types
        description: Types of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: cropIds
        description: CropIds of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: seasonIds
        description: SeasonIds of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: fieldIds
        description: FieldIds of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: sources
        description: Sources of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: ids
        description: Ids of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: names
        description: Names of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: propertyFilters
        description: 'Filters on key-value pairs within the Properties object.

          eg. "{testKey} eq {testValue}".'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: statuses
        description: Statuses of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxPageSize
        description: 'Maximum number of items needed (inclusive).

          Minimum = 10, Maximum = 1000, Default value = 50.'
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementZoneListResponse'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ManagementZones_List:
          $ref: ./examples/ManagementZones_List.json
      summary: Microsoft Azure Get Management Zones
  /management-zones/cascade-delete/{jobId}:
    get:
      tags:
      - ManagementZones
      description: Get a cascade delete job for specified job id.
      operationId: microsoftAzureManagementzonesGetcascadedeletejobdetails
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CascadeDeleteJob'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        ManagementZones_GetCascadeDeleteJobDetails:
          $ref: ./examples/ManagementZones_GetCascadeDeleteJobDetails.json
      summary: Microsoft Azure Get Management Zones Cascade Delete Jobid
    put:
      tags:
      - ManagementZones
      description: Create a cascade delete job for specified management zone.
      operationId: microsoftAzureManagementzonesCreatecascadedeletejob
      parameters:
      - in: path
        name: jobId
        description: Job ID supplied by end user.
        required: true
        schema:
          type: string
      - in: query
        name: partyId
        description: ID of the associated party.
        required: true
        schema:
          type: string
      - in: query
        name: managementZoneId
        description: ID of the management zone to be deleted.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CascadeDeleteJob'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        ManagementZones_CreateCascadeDeleteJob:
          $ref: ./examples/ManagementZones_CreateCascadeDeleteJob.json
      summary: Microsoft Azure Put Management Zones Cascade Delete Jobid
  /parties/{partyId}/management-zones:
    get:
      tags:
      - ManagementZones
      description: Returns a paginated list of management zone resources under a particular party.
      operationId: microsoftAzureManagementzonesListbypartyid
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: query
        name: types
        description: Types of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: cropIds
        description: CropIds of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: seasonIds
        description: SeasonIds of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: fieldIds
        description: FieldIds of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: sources
        description: Sources of the ManagementZone.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: ids
        description: Ids of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: names
        description: Names of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: propertyFilters
        description: 'Filters on key-value pairs within the Properties object.

          eg. "{testKey} eq {testValue}".'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: statuses
        description: Statuses of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxPageSize
        description: 'Maximum number of items needed (inclusive).

          Minimum = 10, Maximum = 1000, Default value = 50.'
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementZoneListResponse'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ManagementZones_ListByPartyId:
          $ref: ./examples/ManagementZones_ListByPartyId.json
      summary: Microsoft Azure Get Parties Partyid Management Zones
  /parties/{partyId}/management-zones/{managementZoneId}:
    get:
      tags:
      - ManagementZones
      description: Gets a specified management zone resource under a particular party.
      operationId: microsoftAzureManagementzonesGet
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: path
        name: managementZoneId
        description: Id of the management zone.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementZone'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        ManagementZones_Get:
          $ref: ./examples/ManagementZones_Get.json
      summary: Microsoft Azure Get Parties Partyid Management Zones Managementzoneid
    patch:
      tags:
      - ManagementZones
      description: Creates or updates a management zone resource.
      operationId: microsoftAzureManagementzonesCreateorupdate
      parameters:
      - in: path
        name: partyId
        description: Id of the party resource.
        required: true
        schema:
          type: string
      - in: path
        name: managementZoneId
        description: Id of the management zone resource.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementZone'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementZone'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        ManagementZones_CreateOrUpdate:
          $ref: ./examples/ManagementZones_CreateOrUpdate.json
      summary: Microsoft Azure Patch Parties Partyid Management Zones Managementzoneid
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/ManagementZone'
        description: ManagementZone resource payload to create or update.
        required: true
    delete:
      tags:
      - ManagementZones
      description: Deletes a specified management zone resource under a particular party.
      operationId: microsoftAzureManagementzonesDelete
      parameters:
      - in: path
        name: partyId
        description: Id of the party.
        required: true
        schema:
          type: string
      - in: path
        name: managementZoneId
        description: Id of the management zone.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        ManagementZones_Delete:
          $ref: ./examples/ManagementZones_Delete.json
      summary: Microsoft Azure Delete Parties Partyid Management Zones Managementzoneid
components:
  schemas:
    Error:
      description: An error from the Azure AgPlatform service.
      required:
      - code
      - message
      type: object
      properties:
        code:
          description: Server-defined set of error codes.
          minLength: 1
          type: string
        message:
          description: Human-readable representation of the error.
          minLength: 1
          type: string
        target:
          description: Target of the error.
          type: string
        details:
          description: Array of details about specific errors that led to this reported error.
          type: array
          items:
            $ref: '#/components/schemas/Error'
        innererror:
          $ref: '#/components/schemas/InnerError'
    CascadeDeleteJob:
      description: Schema of cascade delete job.
      required:
      - partyId
      - resourceId
      - resourceType
      type: object
      properties:
        partyId:
          description: Party Id.
          minLength: 1
          type: string
        resourceId:
          description: The id of the resource.
          minLength: 1
          type: string
        resourceType:
          description: The type of the resource.
          minLength: 1
          type: string
        id:
          description: Unique job id.
          type: string
          readOnly: true
        status:
          description: 'Status of the job.

            Possible values: ''Waiting'', ''Running'', ''Succeeded'', ''Failed'', ''Cancelled''.'
          enum:
          - Waiting
          - Running
          - Succeeded
          - Failed
          - Cancelled
          type: string
          readOnly: true
          x-ms-enum:
            name: JobStatus
            modelAsString: true
        durationInSeconds:
          format: double
          description: Duration of the job in seconds.
          type: number
          readOnly: true
        message:
          description: Status message to capture more details of the job.
          type: string
          readOnly: true
        errorCode:
          description: Error Code when job failed.
          type: string
          readOnly: true
        createdDateTime:
          format: date-time
          description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
        lastActionDateTime:
          format: date-time
          description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
        startTime:
          format: date-time
          description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
        endTime:
          format: date-time
          description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
    ManagementZone:
      description: Api Model for ManagementZone object.
      type: object
      properties:
        partyId:
          description: Party Id associated with the ManagementZone.
          type: string
          readOnly: true
        type:
          description: Type of the ManagementZone.
          maxLength: 100
          minLength: 0
          type: string
        seasonId:
          description: Season Id associated with the ManagementZone.
          type: string
        cropId:
          description: Crop Id associated with the ManagementZone.
          type: string
        fieldId:
          description: Field Id associated with the ManagementZone.
          type: string
        id:
          description: Unique resource ID.
          type: string
          readOnly: true
        eTag:
          description: The ETag value to implement optimistic concurrency.
          type: string
          readOnly: true
        status:
          description: Status of the resource.
          maxLength: 100
          minLength: 0
          type: string
        createdDateTime:
          format: date-time
          description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
          example: '2020-12-31T11:10:21Z'
        modifiedDateTime:
          format: date-time
          description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
          type: string
          readOnly: true
          example: '2020-12-31T11:10:21Z'
        source:
          description: Source of the resource.
          maxLength: 100
          minLength: 2
          type: string
        name:
          description: Name to identify resource.
          maxLength: 100
          minLength: 0
          type: string
        description:
          description: Textual description of the resource.
          maxLength: 500
          minLength: 0
          type: string
        createdBy:
          description: Created by user/tenant id.
          type: string
          readOnly: true
        modifiedBy:
          description: Modified by user/tenant id.
          type: string
          readOnly: true
        properties:
          description: 'A collection of key value pairs that belongs to the resource.

            Each pair must not have a key greater than 50 characters

            and must not have a value greater than 150 characters.

            Note: A maximum of 25 key value pairs can be provided for a resource and only string,

            numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.'
          type: object
          additionalProperties: {}
          example:
            key1: value1
            key2: 123.45
    ManagementZoneListResponse:
      description: Paged response contains list of requested objects and a URL link to get the next set of results.
      required:
      - value
      type: object
      properties:
        value:
          description: List of requested objects.
          type: array
          items:
            $ref: '#/components/schemas/ManagementZone'
        skipToken:
          description: Token used in retrieving the next page. If null, there are no additional pages.
          type: string
        nextLink:
          description: Continuation link (absolute URI) to the next page of results in the list.
          type: string
    InnerError:
      description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
      type: object
      properties:
        code:
          description: Specific error code than was provided by the containing error.
          type: string
        innererror:
          $ref: '#/components/schemas/InnerError'
    ErrorResponse:
      description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
        traceId:
          description: Unique trace Id.
          type: string
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.
x-refined-from:
- azure-agfoodplatform-data-plane-service-openapi-original.yml
- microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'