Microsoft Azure Broker API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Broker API
schemes:
- https
tags:
- name: Broker
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker:
    get:
      operationId: microsoftAzureBrokerListbymqresource
      tags:
      - Broker
      description: List BrokerResource resources by MqResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Broker_ListByMqResource:
          $ref: ./examples/Broker_ListByMqResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}
  : get:
      operationId: microsoftAzureBrokerGet
      tags:
      - Broker
      description: Get a BrokerResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Broker_Get:
          $ref: ./examples/Broker_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
    put:
      operationId: microsoftAzureBrokerCreateorupdate
      tags:
      - Broker
      description: Create a BrokerResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/BrokerResource'
      responses:
        '200':
          description: Resource 'BrokerResource' update operation succeeded
          schema:
            $ref: '#/definitions/BrokerResource'
        '201':
          description: Resource 'BrokerResource' create operation succeeded
          schema:
            $ref: '#/definitions/BrokerResource'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Broker_CreateOrUpdate:
          $ref: ./examples/Broker_CreateOrUpdate_MaximumSet_Gen.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
    patch:
      operationId: microsoftAzureBrokerUpdate
      tags:
      - Broker
      description: Update a BrokerResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/BrokerResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Broker_Update:
          $ref: ./examples/Broker_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
    delete:
      operationId: microsoftAzureBrokerDelete
      tags:
      - Broker
      description: Delete a BrokerResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Broker_Delete:
          $ref: ./examples/Broker_Delete_MaximumSet_Gen.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername
definitions:
  VolumeClaimDataSource:
    type: object
    description: VolumeClaimDataSource properties
    properties:
      apiGroup:
        type: string
        description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
      kind:
        type: string
        description: Kind is the type of resource being referenced
      name:
        type: string
        description: Name is the name of resource being referenced
    required:
    - kind
    - name
  BrokerResourceUpdateProperties:
    type: object
    description: The updatable properties of the BrokerResource.
    properties:
      authImage:
        $ref: '#/definitions/ContainerImageUpdate'
        description: The details of Authentication Docker Image.
      brokerImage:
        $ref: '#/definitions/ContainerImageUpdate'
        description: The details of Broker Docker Image.
      brokerNodeTolerations:
        $ref: '#/definitions/NodeTolerationsUpdate'
        description: The details of Node Tolerations for Broker Pods.
      cardinality:
        $ref: '#/definitions/CardinalityUpdate'
        description: The cardinality details of the broker.
      diagnostics:
        $ref: '#/definitions/BrokerDiagnostics'
        description: The diagnostic details of the broker deployment.
      diskBackedMessageBufferSettings:
        $ref: '#/definitions/DiskBackedMessageBufferSettingsUpdate'
        description: The settings of the disk-backed message buffer.
      encryptInternalTraffic:
        type: boolean
        description: The setting to enable or disable encryption of internal Traffic.
        default: true
      healthManagerImage:
        $ref: '#/definitions/ContainerImageUpdate'
        description: The details of Health Manager Docker Image.
      healthManagerNodeTolerations:
        $ref: '#/definitions/NodeTolerationsUpdate'
        description: The details of Node Tolerations for Health Manager Pods.
      internalCerts:
        $ref: '#/definitions/CertManagerCertOptionsUpdate'
        description: Details of the internal CA cert that will be used to secure communication between pods.
      memoryProfile:
        type: string
        description: Memory profile of broker.
        default: medium
        enum:
        - tiny
        - low
        - medium
        - high
        x-ms-enum:
          name: BrokerMemoryProfile
          modelAsString: true
          values:
          - name: tiny
            value: tiny
            description: Tiny memory profile.
          - name: low
            value: low
            description: Low memory profile.
          - name: medium
            value: medium
            description: Medium memory profile.
          - name: high
            value: high
            description: High memory profile.
      mode:
        $ref: '#/definitions/RunMode'
        description: The Running Mode of the Broker Deployment.
  BackendChain:
    type: object
    description: Desired properties of the Frontend Instances of the DMQTT Broker
    properties:
      partitions:
        type: integer
        format: int32
        description: Partitions is desired number of physical backend chains of the given distributed MQTT broker.
        minimum: 0
        maximum: 65535
      redundancyFactor:
        type: integer
        format: int32
        description: Redundancy Factor is desired numbers of broker instances in one chain.
        minimum: 0
        maximum: 65535
      temporaryDiskTransferEnabled:
        type: boolean
        description: Defines whether disk transfer is enabled or not.
      temporaryDiskTransferHighWatermarkPercent:
        type: integer
        format: int32
        description: Defines the percentage usage of buffer pool above which disk transfer will start.
        minimum: 0
        maximum: 100
      temporaryDiskTransferLowWatermarkPercent:
        type: integer
        format: int32
        description: Defines the percentage usage of buffer pool below which disk transfer will stop.
        minimum: 0
        maximum: 100
      temporaryMaxBackendMemUsagePercent:
        type: integer
        format: int32
        description: Defines the limits for memory usage percent of the backend instances of the MQTT broker.
        minimum: 0
        maximum: 100
      temporaryResourceLimits:
        $ref: '#/definitions/TemporaryResourceLimitsConfig'
        description: Defines the limits for resources of the backend instances of the MQTT broker.
      workers:
        type: integer
        format: int32
        description: Number of logical backend workers per pod.
        default: 1
        minimum: 0
        maximum: 65535
    required:
    - partitions
    - redundancyFactor
  DiskBackedMessageBufferSettings:
    type: object
    description: DiskBackedMessageBufferSettings properties
    properties:
      ephemeralVolumeClaimSpec:
        $ref: '#/definitions/VolumeClaimSpec'
        description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See <https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes> for details.
      maxSize:
        type: string
        description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See <https://kubernetes.io/docs/concepts/storage/volumes/#emptydir> for details.
      persistentVolumeClaimSpec:
        $ref: '#/definitions/VolumeClaimSpec'
        description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer.
    required:
    - maxSize
  BrokerResourceUpdate:
    type: object
    description: The type used for update operations of the BrokerResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/BrokerResourceUpdateProperties'
        x-ms-client-flatten: true
  TemporaryResourceLimitsConfigUpdate:
    type: object
    description: Internal knobs of Resource Limits for FE and BE
    properties:
      maxInflightMessages:
        type: integer
        format: int32
        description: Maximum number of messages a client can have inflight.
        minimum: 0
        maximum: 65535
      maxInflightPatches:
        type: integer
        format: int32
        description: Maximum number of patch inflight per node.
        minimum: 0
        maximum: 65535
      maxInflightPatchesPerClient:
        type: integer
        format: int32
        description: Maximum number of patch a client can have in flight.
        minimum: 0
        maximum: 65535
      maxMessageExpirySecs:
        type: integer
        format: int64
        description: Maximum message expiry interval, in seconds.
        minimum: 0
        maximum: 4294967295
      maxQueuedMessages:
        type: integer
        format: int64
        description: Maximum receive for external clients.
        minimum: 0
        maximum: 9223372036854000000
      maxQueuedQos0Messages:
        type: integer
        format: int64
        description: Maximum receive QoS0 for external clients.
        minimum: 0
        maximum: 9223372036854000000
      maxSessionExpirySecs:
        type: integer
        format: int64
        description: Maximum session expiry interval, in seconds.
        minimum: 0
        maximum: 4294967295
  DiskBackedMessageBufferSettingsUpdate:
    type: object
    description: DiskBackedMessageBufferSettings properties
    properties:
      ephemeralVolumeClaimSpec:
        $ref: '#/definitions/VolumeClaimSpecUpdate'
        description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See <https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes> for details.
      maxSize:
        type: string
        description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See <https://kubernetes.io/docs/concepts/storage/volumes/#emptydir> for details.
      persistentVolumeClaimSpec:
        $ref: '#/definitions/VolumeClaimSpecUpdate'
        description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer.
  CertManagerPrivateKeyUpdate:
    type: object
    description: Cert Manager private key properties
    properties:
      algorithm:
        type: string
        description: algorithm for private key.
        default: ECDSA
      rotationPolicy:
        type: string
        description: cert-manager rotationPolicy.
        default: Always
      size:
        type: integer
        format: int32
        description: size of private key.
        default: 256
        minimum: 0
        maximum: 65535
  VolumeClaimDataSourceUpdate:
    type: object
    description: VolumeClaimDataSource properties
    properties:
      apiGroup:
        type: string
        description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
      kind:
        type: string
        description: Kind is the type of resource being referenced
      name:
        type: string
        description: Name is the name of resource being referenced
  ExtendedLocationProperty:
    type: object
    description: ExtendedLocation properties
    properties:
      name:
        type: string
        description: The name of the extended location.
      type:
        $ref: '#/definitions/ExtendedLocationType'
        description: Type of ExtendedLocation.
    required:
    - name
    - type
  FrontendUpdate:
    type: object
    description: Desired properties of the Frontend Instances of the DMQTT Broker
    properties:
      replicas:
        type: integer
        format: int32
        description: Replicas is desired number of frontend replicas of the given distributed MQTT broker.
        minimum: 0
        maximum: 65535
      temporaryResourceLimits:
        $ref: '#/definitions/TemporaryResourceLimitsConfigUpdate'
        description: Defines the limits for resources of the frontend instances of the MQTT broker.
      workers:
        type: integer
        format: int32
        description: Number of logical frontend workers per pod.
        default: 2
        minimum: 0
        maximum: 65535
  BackendChainUpdate:
    type: object
    description: Desired properties of the Frontend Instances of the DMQTT Broker
    properties:
      partitions:
        type: integer
        format: int32
        description: Partitions is desired number of physical backend chains of the given distributed MQTT broker.
        minimum: 0
        maximum: 65535
      redundancyFactor:
        type: integer
        format: int32
        description: Redundancy Factor is desired numbers of broker instances in one chain.
        minimum: 0
        maximum: 65535
      temporaryDiskTransferEnabled:
        type: boolean
        description: Defines whether disk transfer is enabled or not.
      temporaryDiskTransferHighWatermarkPercent:
        type: integer
        format: int32
        description: Defines the percentage usage of buffer pool above which disk transfer will start.
        minimum: 0
        maximum: 100
      temporaryDiskTransferLowWatermarkPercent:
        type: integer
        format: int32
        description: Defines the percentage usage of buffer pool below which disk transfer will stop.
        minimum: 0
        maximum: 100
      temporaryMaxBackendMemUsagePercent:
        type: integer
        format: int32
        description: Defines the limits for memory usage percent of the backend instances of the MQTT broker.
        minimum: 0
        maximum: 100
      temporaryResourceLimits:
        $ref: '#/definitions/TemporaryResourceLimitsConfigUpdate'
        description: Defines the limits for resources of the backend instances of the MQTT broker.
      workers:
        type: integer
        format: int32
        description: Number of logical backend workers per pod.
        default: 1
        minimum: 0
        maximum: 65535
  Cardinality:
    type: object
    description: Cardinality properties
    properties:
      backendChain:
        $ref: '#/definitions/BackendChain'
        description: The backend broker desired properties
      frontend:
        $ref: '#/definitions/Frontend'
        description: The frontend broker desired properties
    required:
    - backendChain
    - frontend
  TemporaryResourceLimitsConfig:
    type: object
    description: Internal knobs of Resource Limits for FE and BE
    properties:
      maxInflightMessages:
        type: integer
        format: int32
        description: Maximum number of messages a client can have inflight.
        minimum: 0
        maximum: 65535
      maxInflightPatches:
        type: integer
        format: int32
        description: Maximum number of patch inflight per node.
        minimum: 0
        maximum: 65535
      maxInflightPatchesPerClient:
        type: integer
        format: int32
        description: Maximum number of patch a client can have in flight.
        minimum: 0
        maximum: 65535
      maxMessageExpirySecs:
        type: integer
        format: int64
        description: Maximum message expiry interval, in seconds.
        minimum: 0
        maximum: 4294967295
      maxQueuedMessages:
        type: integer
        format: int64
        description: Maximum receive for external clients.
        minimum: 0
        maximum: 9223372036854000000
      maxQueuedQos0Messages:
        type: integer
        format: int64
        description: Maximum receive QoS0 for external clients.
        minimum: 0
        maximum: 9223372036854000000
      maxSessionExpirySecs:
        type: integer
        format: int64
        description: Maximum session expiry interval, in seconds.
        minimum: 0
        maximum: 4294967295
    required:
    - maxInflightMessages
    - maxInflightPatches
    - maxInflightPatchesPerClient
    - maxQueuedMessages
    - maxQueuedQos0Messages
    - maxSessionExpirySecs
  VolumeClaimResourceRequirements:
    type: object
    description: VolumeClaimResourceRequirements properties
    properties:
      limits:
        type: object
        description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
        additionalProperties:
          type: string
      requests:
        type: object
        description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
        additionalProperties:
          type: string
  BrokerResourceListResult:
    type: object
    description: The response of a BrokerResource list operation.
    properties:
      value:
        type: array
        description: The BrokerResource items on this page
        items:
          $ref: '#/definitions/BrokerResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  BrokerProperties:
    type: object
    description: Broker Resource properties
    properties:
      authImage:
        $ref: '#/definitions/ContainerImage'
        description: The details of Authentication Docker Image.
      brokerImage:
        $ref: '#/definitions/ContainerImage'
        description: The details of Broker Docker Image.
      brokerNodeTolerations:
        $ref: '#/definitions/NodeTolerations'
        description: The details of Node Tolerations for Broker Pods.
      cardinality:
        $ref: '#/definitions/Cardinality'
        description: The cardinality details of the broker.
      diagnostics:
        $ref: '#/definitions/BrokerDiagnostics'
        description: The diagnostic details of the broker deployment.
      diskBackedMessageBufferSettings:
        $ref: '#/definitions/DiskBackedMessageBufferSettings'
        description: The settings of the disk-backed message buffer.
      encryptInternalTraffic:
        type: boolean
        description: The setting to enable or disable encryption of internal Traffic.
        default: true
      healthManagerImage:
        $ref: '#/definitions/ContainerImage'
        description: The details of Health Manager Docker Image.
      healthManagerNodeTolerations:
        $ref: '#/definitions/NodeTolerations'
        description: The details of Node Tolerations for Health Manager Pods.
      internalCerts:
        $ref: '#/definitions/CertManagerCertOptions'
        description: Details of the internal CA cert that will be used to secure communication between pods.
      memoryProfile:
        type: string
        description: Memory profile of broker.
        default: medium
        enum:
        - tiny
        - low
        - medium
        - high
        x-ms-enum:
          name: BrokerMemoryProfile
          modelAsString: true
          values:
          - name: tiny
            value: tiny
            description: Tiny memory profile.
          - name: low
            value: low
            description: Low memory profile.
          - name: medium
            value: medium
            description: Medium memory profile.
          - name: high
            value: high
            description: High memory profile.
      mode:
        $ref: '#/definitions/RunMode'
        description: The Running Mode of the Broker Deployment.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - authImage
    - brokerImage
    - healthManagerImage
    - mode
  VolumeClaimSpecSelector:
    type: object
    description: VolumeClaimSpecSelector properties
    properties:
      matchExpressions:
        type: array
        description: MatchExpressions is a list of label selector requirements. The requirements are ANDed.
        items:
          $ref: '#/definitions/VolumeClaimSpecSelectorMatchExpressions'
        x-ms-identifiers: []
      matchLabels:
        type: object
        description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
        additionalProperties:
          type: string
  CertManagerCertOptionsUpdate:
    type: object
    description: Cert Manager CA Cert properties
    properties:
      duration:
        type: string
        description: Duration of CA cert.
        default: 720h
      privateKey:
        $ref: '#/definitions/CertManagerPrivateKeyUpdate'
        description: Cert Manager private key.
      renewBefore:
        type: string
        description: Renew before time of CA cert.
        default: 240h
  VolumeClaimDataSourceRef:
    type: object
    description: VolumeClaimDataSourceRef properties
    properties:
      apiGroup:
        type: string
        description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
      kind:
        type: string
        description: Kind is the type of resource being referenced
      name:
        type: string
        description: Name is the name of resource being referenced
    required:
    - kind
    - name
  CertManagerCertOptions:
    type: object
    description: Cert Manager CA Cert properties
    properties:
      duration:
        type: string
        description: Duration of CA cert.
        default: 720h
      privateKey:
        $ref: '#/definitions/CertManagerPrivateKey'
        description: Cert Manager private key.
      renewBefore:
        type: string
        description: Renew before time of CA cert.
        default: 240h
    required:
    - duration
    - privateKey
    - renewBefore
  VolumeClaimSpecUpdate:
    type: object
    description: VolumeClaimSpec properties
    properties:
      accessModes:
        type: array
        description: 'AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
        items:
          type: string
        x-ms-identifiers: []
      dataSource:
        $ref: '#/definitions/VolumeClaimDataSourceUpdate'
        description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.'
      dataSourceRef:
        $ref: '#/definitions/VolumeClaimDataSourceRefUpdate'
        description: 'Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.'
      resources:
        $ref: '#/definitions/VolumeClaimResourceRequirements'
        description: 'Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
      selector:
        $ref: '#/definitions/VolumeClaimSpecSelector'
        description: A label query over volumes to consider for binding.
    

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-broker-api-openapi.yml