azure-resource-manager-schemas/schemas/2021-12-01/Microsoft.Purview.json

{
  "id": "https://schema.management.azure.com/schemas/2021-12-01/Microsoft.Purview.json#",
  "title": "Microsoft.Purview",
  "description": "Microsoft Purview Resource Types",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "resourceDefinitions": {
    "accounts": {
      "description": "Microsoft.Purview/accounts",
      "properties": {
        "apiVersion": {
          "enum": [
            "2021-12-01"
          ],
          "type": "string"
        },
        "identity": {
          "description": "Identity Info on the tracked resource",
          "oneOf": [
            {
              "$ref": "#/definitions/Identity"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "location": {
          "description": "Gets or sets the location.",
          "type": "string"
        },
        "name": {
          "description": "The name of the account.",
          "oneOf": [
            {
              "maxLength": 63,
              "minLength": 3,
              "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "properties": {
          "description": "Gets or sets the properties.",
          "oneOf": [
            {
              "$ref": "#/definitions/AccountProperties"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "resources": {
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/accounts_kafkaConfigurations_childResource"
              },
              {
                "$ref": "#/definitions/accounts_privateEndpointConnections_childResource"
              }
            ]
          },
          "type": "array"
        },
        "tags": {
          "description": "Tags on the azure resource.",
          "oneOf": [
            {
              "additionalProperties": {
                "type": "string"
              },
              "properties": {},
              "type": "object"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "type": {
          "enum": [
            "Microsoft.Purview/accounts"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "properties",
        "apiVersion",
        "type"
      ],
      "type": "object"
    },
    "accounts_kafkaConfigurations": {
      "description": "Microsoft.Purview/accounts/kafkaConfigurations",
      "properties": {
        "apiVersion": {
          "enum": [
            "2021-12-01"
          ],
          "type": "string"
        },
        "name": {
          "description": "The kafka configuration name.",
          "oneOf": [
            {
              "maxLength": 63,
              "minLength": 3,
              "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "properties": {
          "description": "Gets or sets the kafka configuration properties.",
          "oneOf": [
            {
              "$ref": "#/definitions/KafkaConfigurationProperties"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "type": {
          "enum": [
            "Microsoft.Purview/accounts/kafkaConfigurations"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "properties",
        "apiVersion",
        "type"
      ],
      "type": "object"
    },
    "accounts_privateEndpointConnections": {
      "description": "Microsoft.Purview/accounts/privateEndpointConnections",
      "properties": {
        "apiVersion": {
          "enum": [
            "2021-12-01"
          ],
          "type": "string"
        },
        "name": {
          "description": "Name of the private endpoint connection.",
          "type": "string"
        },
        "properties": {
          "description": "The connection identifier.",
          "oneOf": [
            {
              "$ref": "#/definitions/PrivateEndpointConnectionProperties"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "type": {
          "enum": [
            "Microsoft.Purview/accounts/privateEndpointConnections"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "properties",
        "apiVersion",
        "type"
      ],
      "type": "object"
    }
  },
  "definitions": {
    "AccountProperties": {
      "description": "The account properties",
      "properties": {
        "cloudConnectors": {
          "description": "Cloud connectors.\r\nExternal cloud identifier used as part of scanning configuration.",
          "oneOf": [
            {
              "$ref": "#/definitions/CloudConnectors"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "managedEventHubState": {
          "description": " Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.",
          "oneOf": [
            {
              "enum": [
                "NotSpecified",
                "Disabled",
                "Enabled"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "managedResourceGroupName": {
          "description": "Gets or sets the managed resource group name",
          "type": "string"
        },
        "managedResourcesPublicNetworkAccess": {
          "description": "Gets or sets the public network access for managed resources.",
          "oneOf": [
            {
              "enum": [
                "NotSpecified",
                "Enabled",
                "Disabled"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "publicNetworkAccess": {
          "description": "Gets or sets the public network access.",
          "oneOf": [
            {
              "enum": [
                "NotSpecified",
                "Enabled",
                "Disabled"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "type": "object"
    },
    "CloudConnectors": {
      "description": "External Cloud Service connectors",
      "properties": {},
      "type": "object"
    },
    "Credentials": {
      "description": "Credentials to access the event streaming service attached to the purview account.",
      "properties": {
        "identityId": {
          "description": "Identity identifier for UserAssign type.",
          "type": "string"
        },
        "type": {
          "description": "Identity Type.",
          "oneOf": [
            {
              "enum": [
                "None",
                "SystemAssigned",
                "UserAssigned"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "type": "object"
    },
    "Identity": {
      "description": "The Managed Identity of the resource",
      "properties": {
        "type": {
          "description": "Identity Type",
          "oneOf": [
            {
              "enum": [
                "None",
                "SystemAssigned",
                "UserAssigned"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "userAssignedIdentities": {
          "description": "User Assigned Identities",
          "oneOf": [
            {
              "additionalProperties": {
                "$ref": "#/definitions/UserAssignedIdentity"
              },
              "properties": {},
              "type": "object"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "type": "object"
    },
    "KafkaConfigurationProperties": {
      "description": "The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications.",
      "properties": {
        "consumerGroup": {
          "description": "Consumer group for hook event hub.",
          "type": "string"
        },
        "credentials": {
          "description": "Credentials to access event hub.",
          "oneOf": [
            {
              "$ref": "#/definitions/Credentials"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "eventHubPartitionId": {
          "description": "Optional partition Id for notification event hub. If not set, all partitions will be leveraged.",
          "type": "string"
        },
        "eventHubResourceId": {
          "type": "string"
        },
        "eventHubType": {
          "description": "The event hub type.",
          "oneOf": [
            {
              "enum": [
                "Notification",
                "Hook"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "eventStreamingState": {
          "description": "The state of the event streaming service",
          "oneOf": [
            {
              "enum": [
                "Disabled",
                "Enabled"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "eventStreamingType": {
          "description": "The event streaming service type",
          "oneOf": [
            {
              "enum": [
                "None",
                "Managed",
                "Azure"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "type": "object"
    },
    "PrivateEndpoint": {
      "description": "A private endpoint class.",
      "properties": {
        "id": {
          "description": "The private endpoint identifier.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PrivateEndpointConnectionProperties": {
      "description": "A private endpoint connection properties class.",
      "properties": {
        "privateEndpoint": {
          "description": "The private endpoint information.",
          "oneOf": [
            {
              "$ref": "#/definitions/PrivateEndpoint"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "privateLinkServiceConnectionState": {
          "description": "The private link service connection state.",
          "oneOf": [
            {
              "$ref": "#/definitions/PrivateLinkServiceConnectionState"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "type": "object"
    },
    "PrivateLinkServiceConnectionState": {
      "description": "The private link service connection state.",
      "properties": {
        "actionsRequired": {
          "description": "The required actions.",
          "type": "string"
        },
        "description": {
          "description": "The description.",
          "type": "string"
        },
        "status": {
          "description": "The status.",
          "oneOf": [
            {
              "enum": [
                "Unknown",
                "Pending",
                "Approved",
                "Rejected",
                "Disconnected"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "type": "object"
    },
    "UserAssignedIdentity": {
      "description": "Uses client ID and Principal ID",
      "properties": {},
      "type": "object"
    },
    "accounts_kafkaConfigurations_childResource": {
      "description": "Microsoft.Purview/accounts/kafkaConfigurations",
      "properties": {
        "apiVersion": {
          "enum": [
            "2021-12-01"
          ],
          "type": "string"
        },
        "name": {
          "description": "The kafka configuration name.",
          "oneOf": [
            {
              "maxLength": 63,
              "minLength": 3,
              "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "properties": {
          "description": "Gets or sets the kafka configuration properties.",
          "oneOf": [
            {
              "$ref": "#/definitions/KafkaConfigurationProperties"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "type": {
          "enum": [
            "kafkaConfigurations"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "properties",
        "apiVersion",
        "type"
      ],
      "type": "object"
    },
    "accounts_privateEndpointConnections_childResource": {
      "description": "Microsoft.Purview/accounts/privateEndpointConnections",
      "properties": {
        "apiVersion": {
          "enum": [
            "2021-12-01"
          ],
          "type": "string"
        },
        "name": {
          "description": "Name of the private endpoint connection.",
          "type": "string"
        },
        "properties": {
          "description": "The connection identifier.",
          "oneOf": [
            {
              "$ref": "#/definitions/PrivateEndpointConnectionProperties"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "type": {
          "enum": [
            "privateEndpointConnections"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "properties",
        "apiVersion",
        "type"
      ],
      "type": "object"
    }
  }
}