Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware
published on Friday, Oct 23, 2026 by vmware
avi
Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware
published on Friday, Oct 23, 2026 by vmware
<!–
Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0
–>
layout: “avi”
page_title: “Avi: avi.Apischema”
sidebar_current: “docs-avi-resource-apischema”
description: |-
Creates and manages Avi ApiSchema.
avi.Apischema
The ApiSchema resource allows the creation and management of Avi ApiSchema
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";
const foo = new avi.Apischema("foo", {
name: "terraform-example-foo",
tenantRef: "/api/tenant/?name=admin",
});
import pulumi
import pulumi_avi as avi
foo = avi.Apischema("foo",
name="terraform-example-foo",
tenant_ref="/api/tenant/?name=admin")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v32/avi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := avi.NewApischema(ctx, "foo", &avi.ApischemaArgs{
Name: pulumi.String("terraform-example-foo"),
TenantRef: pulumi.String("/api/tenant/?name=admin"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;
return await Deployment.RunAsync(() =>
{
var foo = new Avi.Apischema("foo", new()
{
Name = "terraform-example-foo",
TenantRef = "/api/tenant/?name=admin",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Apischema;
import com.pulumi.avi.ApischemaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foo = new Apischema("foo", ApischemaArgs.builder()
.name("terraform-example-foo")
.tenantRef("/api/tenant/?name=admin")
.build());
}
}
resources:
foo:
type: avi:Apischema
properties:
name: terraform-example-foo
tenantRef: /api/tenant/?name=admin
Example coming soon!
Create Apischema Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Apischema(name: string, args: ApischemaArgs, opts?: CustomResourceOptions);@overload
def Apischema(resource_name: str,
args: ApischemaArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Apischema(resource_name: str,
opts: Optional[ResourceOptions] = None,
type: Optional[str] = None,
discriminators: Optional[Sequence[ApischemaDiscriminatorArgs]] = None,
min_items: Optional[str] = None,
apischema_id: Optional[str] = None,
array_item_types: Optional[Sequence[ApischemaArrayItemTypeArgs]] = None,
composite_types: Optional[Sequence[ApischemaCompositeTypeArgs]] = None,
configpb_attributes: Optional[Sequence[ApischemaConfigpbAttributeArgs]] = None,
description: Optional[str] = None,
additional_object_key_action: Optional[str] = None,
allow_additional_properties: Optional[str] = None,
name: Optional[str] = None,
max_items: Optional[str] = None,
object_properties: Optional[Sequence[ApischemaObjectPropertyArgs]] = None,
source: Optional[str] = None,
tenant_ref: Optional[str] = None,
additional_properties_schemas: Optional[Sequence[ApischemaAdditionalPropertiesSchemaArgs]] = None,
unique_items: Optional[str] = None,
uuid: Optional[str] = None)func NewApischema(ctx *Context, name string, args ApischemaArgs, opts ...ResourceOption) (*Apischema, error)public Apischema(string name, ApischemaArgs args, CustomResourceOptions? opts = null)
public Apischema(String name, ApischemaArgs args)
public Apischema(String name, ApischemaArgs args, CustomResourceOptions options)
type: avi:Apischema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "avi_apischema" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ApischemaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApischemaArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApischemaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApischemaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApischemaArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apischemaResource = new Avi.Apischema("apischemaResource", new()
{
Type = "string",
Discriminators = new[]
{
new Avi.Inputs.ApischemaDiscriminatorArgs
{
Mappings = new[]
{
new Avi.Inputs.ApischemaDiscriminatorMappingArgs
{
DiscriminatorKey = "string",
SchemaRef = "string",
},
},
PropertyName = "string",
},
},
MinItems = "string",
ApischemaId = "string",
ArrayItemTypes = new[]
{
new Avi.Inputs.ApischemaArrayItemTypeArgs
{
MaxValue = "string",
MinValue = "string",
SchemaRef = "string",
StringEnumValues = new[]
{
"string",
},
StringFormat = "string",
StringMaxLength = "string",
StringMinLength = "string",
StringPattern = "string",
Type = "string",
},
},
CompositeTypes = new[]
{
new Avi.Inputs.ApischemaCompositeTypeArgs
{
MaxValue = "string",
MinValue = "string",
SchemaRef = "string",
StringEnumValues = new[]
{
"string",
},
StringFormat = "string",
StringMaxLength = "string",
StringMinLength = "string",
StringPattern = "string",
Type = "string",
},
},
ConfigpbAttributes = new[]
{
new Avi.Inputs.ApischemaConfigpbAttributeArgs
{
CreatedBy = "string",
Version = "string",
},
},
Description = "string",
AdditionalObjectKeyAction = "string",
AllowAdditionalProperties = "string",
Name = "string",
MaxItems = "string",
ObjectProperties = new[]
{
new Avi.Inputs.ApischemaObjectPropertyArgs
{
Name = "string",
Schemas = new[]
{
new Avi.Inputs.ApischemaObjectPropertySchemaArgs
{
MaxValue = "string",
MinValue = "string",
SchemaRef = "string",
StringEnumValues = new[]
{
"string",
},
StringFormat = "string",
StringMaxLength = "string",
StringMinLength = "string",
StringPattern = "string",
Type = "string",
},
},
AccessMode = "string",
Deprecated = "string",
Nullable = "string",
Required = "string",
},
},
Source = "string",
TenantRef = "string",
AdditionalPropertiesSchemas = new[]
{
new Avi.Inputs.ApischemaAdditionalPropertiesSchemaArgs
{
MaxValue = "string",
MinValue = "string",
SchemaRef = "string",
StringEnumValues = new[]
{
"string",
},
StringFormat = "string",
StringMaxLength = "string",
StringMinLength = "string",
StringPattern = "string",
Type = "string",
},
},
UniqueItems = "string",
Uuid = "string",
});
example, err := avi.NewApischema(ctx, "apischemaResource", &avi.ApischemaArgs{
Type: pulumi.String("string"),
Discriminators: avi.ApischemaDiscriminatorArray{
&avi.ApischemaDiscriminatorArgs{
Mappings: avi.ApischemaDiscriminatorMappingArray{
&avi.ApischemaDiscriminatorMappingArgs{
DiscriminatorKey: pulumi.String("string"),
SchemaRef: pulumi.String("string"),
},
},
PropertyName: pulumi.String("string"),
},
},
MinItems: pulumi.String("string"),
ApischemaId: pulumi.String("string"),
ArrayItemTypes: avi.ApischemaArrayItemTypeArray{
&avi.ApischemaArrayItemTypeArgs{
MaxValue: pulumi.String("string"),
MinValue: pulumi.String("string"),
SchemaRef: pulumi.String("string"),
StringEnumValues: pulumi.StringArray{
pulumi.String("string"),
},
StringFormat: pulumi.String("string"),
StringMaxLength: pulumi.String("string"),
StringMinLength: pulumi.String("string"),
StringPattern: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
CompositeTypes: avi.ApischemaCompositeTypeArray{
&avi.ApischemaCompositeTypeArgs{
MaxValue: pulumi.String("string"),
MinValue: pulumi.String("string"),
SchemaRef: pulumi.String("string"),
StringEnumValues: pulumi.StringArray{
pulumi.String("string"),
},
StringFormat: pulumi.String("string"),
StringMaxLength: pulumi.String("string"),
StringMinLength: pulumi.String("string"),
StringPattern: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
ConfigpbAttributes: avi.ApischemaConfigpbAttributeArray{
&avi.ApischemaConfigpbAttributeArgs{
CreatedBy: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
AdditionalObjectKeyAction: pulumi.String("string"),
AllowAdditionalProperties: pulumi.String("string"),
Name: pulumi.String("string"),
MaxItems: pulumi.String("string"),
ObjectProperties: avi.ApischemaObjectPropertyArray{
&avi.ApischemaObjectPropertyArgs{
Name: pulumi.String("string"),
Schemas: avi.ApischemaObjectPropertySchemaArray{
&avi.ApischemaObjectPropertySchemaArgs{
MaxValue: pulumi.String("string"),
MinValue: pulumi.String("string"),
SchemaRef: pulumi.String("string"),
StringEnumValues: pulumi.StringArray{
pulumi.String("string"),
},
StringFormat: pulumi.String("string"),
StringMaxLength: pulumi.String("string"),
StringMinLength: pulumi.String("string"),
StringPattern: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
AccessMode: pulumi.String("string"),
Deprecated: pulumi.String("string"),
Nullable: pulumi.String("string"),
Required: pulumi.String("string"),
},
},
Source: pulumi.String("string"),
TenantRef: pulumi.String("string"),
AdditionalPropertiesSchemas: avi.ApischemaAdditionalPropertiesSchemaArray{
&avi.ApischemaAdditionalPropertiesSchemaArgs{
MaxValue: pulumi.String("string"),
MinValue: pulumi.String("string"),
SchemaRef: pulumi.String("string"),
StringEnumValues: pulumi.StringArray{
pulumi.String("string"),
},
StringFormat: pulumi.String("string"),
StringMaxLength: pulumi.String("string"),
StringMinLength: pulumi.String("string"),
StringPattern: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
UniqueItems: pulumi.String("string"),
Uuid: pulumi.String("string"),
})
resource "avi_apischema" "apischemaResource" {
lifecycle {
create_before_destroy = true
}
type = "string"
discriminators {
mappings {
discriminator_key = "string"
schema_ref = "string"
}
property_name = "string"
}
min_items = "string"
apischema_id = "string"
array_item_types {
max_value = "string"
min_value = "string"
schema_ref = "string"
string_enum_values = ["string"]
string_format = "string"
string_max_length = "string"
string_min_length = "string"
string_pattern = "string"
type = "string"
}
composite_types {
max_value = "string"
min_value = "string"
schema_ref = "string"
string_enum_values = ["string"]
string_format = "string"
string_max_length = "string"
string_min_length = "string"
string_pattern = "string"
type = "string"
}
configpb_attributes {
created_by = "string"
version = "string"
}
description = "string"
additional_object_key_action = "string"
allow_additional_properties = "string"
name = "string"
max_items = "string"
object_properties {
name = "string"
schemas {
max_value = "string"
min_value = "string"
schema_ref = "string"
string_enum_values = ["string"]
string_format = "string"
string_max_length = "string"
string_min_length = "string"
string_pattern = "string"
type = "string"
}
access_mode = "string"
deprecated = "string"
nullable = "string"
required = "string"
}
source = "string"
tenant_ref = "string"
additional_properties_schemas {
max_value = "string"
min_value = "string"
schema_ref = "string"
string_enum_values = ["string"]
string_format = "string"
string_max_length = "string"
string_min_length = "string"
string_pattern = "string"
type = "string"
}
unique_items = "string"
uuid = "string"
}
var apischemaResource = new Apischema("apischemaResource", ApischemaArgs.builder()
.type("string")
.discriminators(ApischemaDiscriminatorArgs.builder()
.mappings(ApischemaDiscriminatorMappingArgs.builder()
.discriminatorKey("string")
.schemaRef("string")
.build())
.propertyName("string")
.build())
.minItems("string")
.apischemaId("string")
.arrayItemTypes(ApischemaArrayItemTypeArgs.builder()
.maxValue("string")
.minValue("string")
.schemaRef("string")
.stringEnumValues("string")
.stringFormat("string")
.stringMaxLength("string")
.stringMinLength("string")
.stringPattern("string")
.type("string")
.build())
.compositeTypes(ApischemaCompositeTypeArgs.builder()
.maxValue("string")
.minValue("string")
.schemaRef("string")
.stringEnumValues("string")
.stringFormat("string")
.stringMaxLength("string")
.stringMinLength("string")
.stringPattern("string")
.type("string")
.build())
.configpbAttributes(ApischemaConfigpbAttributeArgs.builder()
.createdBy("string")
.version("string")
.build())
.description("string")
.additionalObjectKeyAction("string")
.allowAdditionalProperties("string")
.name("string")
.maxItems("string")
.objectProperties(ApischemaObjectPropertyArgs.builder()
.name("string")
.schemas(ApischemaObjectPropertySchemaArgs.builder()
.maxValue("string")
.minValue("string")
.schemaRef("string")
.stringEnumValues("string")
.stringFormat("string")
.stringMaxLength("string")
.stringMinLength("string")
.stringPattern("string")
.type("string")
.build())
.accessMode("string")
.deprecated("string")
.nullable("string")
.required("string")
.build())
.source("string")
.tenantRef("string")
.additionalPropertiesSchemas(ApischemaAdditionalPropertiesSchemaArgs.builder()
.maxValue("string")
.minValue("string")
.schemaRef("string")
.stringEnumValues("string")
.stringFormat("string")
.stringMaxLength("string")
.stringMinLength("string")
.stringPattern("string")
.type("string")
.build())
.uniqueItems("string")
.uuid("string")
.build());
apischema_resource = avi.Apischema("apischemaResource",
type="string",
discriminators=[{
"mappings": [{
"discriminator_key": "string",
"schema_ref": "string",
}],
"property_name": "string",
}],
min_items="string",
apischema_id="string",
array_item_types=[{
"max_value": "string",
"min_value": "string",
"schema_ref": "string",
"string_enum_values": ["string"],
"string_format": "string",
"string_max_length": "string",
"string_min_length": "string",
"string_pattern": "string",
"type": "string",
}],
composite_types=[{
"max_value": "string",
"min_value": "string",
"schema_ref": "string",
"string_enum_values": ["string"],
"string_format": "string",
"string_max_length": "string",
"string_min_length": "string",
"string_pattern": "string",
"type": "string",
}],
configpb_attributes=[{
"created_by": "string",
"version": "string",
}],
description="string",
additional_object_key_action="string",
allow_additional_properties="string",
name="string",
max_items="string",
object_properties=[{
"name": "string",
"schemas": [{
"max_value": "string",
"min_value": "string",
"schema_ref": "string",
"string_enum_values": ["string"],
"string_format": "string",
"string_max_length": "string",
"string_min_length": "string",
"string_pattern": "string",
"type": "string",
}],
"access_mode": "string",
"deprecated": "string",
"nullable": "string",
"required": "string",
}],
source="string",
tenant_ref="string",
additional_properties_schemas=[{
"max_value": "string",
"min_value": "string",
"schema_ref": "string",
"string_enum_values": ["string"],
"string_format": "string",
"string_max_length": "string",
"string_min_length": "string",
"string_pattern": "string",
"type": "string",
}],
unique_items="string",
uuid="string")
const apischemaResource = new avi.Apischema("apischemaResource", {
type: "string",
discriminators: [{
mappings: [{
discriminatorKey: "string",
schemaRef: "string",
}],
propertyName: "string",
}],
minItems: "string",
apischemaId: "string",
arrayItemTypes: [{
maxValue: "string",
minValue: "string",
schemaRef: "string",
stringEnumValues: ["string"],
stringFormat: "string",
stringMaxLength: "string",
stringMinLength: "string",
stringPattern: "string",
type: "string",
}],
compositeTypes: [{
maxValue: "string",
minValue: "string",
schemaRef: "string",
stringEnumValues: ["string"],
stringFormat: "string",
stringMaxLength: "string",
stringMinLength: "string",
stringPattern: "string",
type: "string",
}],
configpbAttributes: [{
createdBy: "string",
version: "string",
}],
description: "string",
additionalObjectKeyAction: "string",
allowAdditionalProperties: "string",
name: "string",
maxItems: "string",
objectProperties: [{
name: "string",
schemas: [{
maxValue: "string",
minValue: "string",
schemaRef: "string",
stringEnumValues: ["string"],
stringFormat: "string",
stringMaxLength: "string",
stringMinLength: "string",
stringPattern: "string",
type: "string",
}],
accessMode: "string",
deprecated: "string",
nullable: "string",
required: "string",
}],
source: "string",
tenantRef: "string",
additionalPropertiesSchemas: [{
maxValue: "string",
minValue: "string",
schemaRef: "string",
stringEnumValues: ["string"],
stringFormat: "string",
stringMaxLength: "string",
stringMinLength: "string",
stringPattern: "string",
type: "string",
}],
uniqueItems: "string",
uuid: "string",
});
type: avi:Apischema
properties:
additionalObjectKeyAction: string
additionalPropertiesSchemas:
- maxValue: string
minValue: string
schemaRef: string
stringEnumValues:
- string
stringFormat: string
stringMaxLength: string
stringMinLength: string
stringPattern: string
type: string
allowAdditionalProperties: string
apischemaId: string
arrayItemTypes:
- maxValue: string
minValue: string
schemaRef: string
stringEnumValues:
- string
stringFormat: string
stringMaxLength: string
stringMinLength: string
stringPattern: string
type: string
compositeTypes:
- maxValue: string
minValue: string
schemaRef: string
stringEnumValues:
- string
stringFormat: string
stringMaxLength: string
stringMinLength: string
stringPattern: string
type: string
configpbAttributes:
- createdBy: string
version: string
description: string
discriminators:
- mappings:
- discriminatorKey: string
schemaRef: string
propertyName: string
maxItems: string
minItems: string
name: string
objectProperties:
- accessMode: string
deprecated: string
name: string
nullable: string
required: string
schemas:
- maxValue: string
minValue: string
schemaRef: string
stringEnumValues:
- string
stringFormat: string
stringMaxLength: string
stringMinLength: string
stringPattern: string
type: string
source: string
tenantRef: string
type: string
uniqueItems: string
uuid: string
Apischema Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Apischema resource accepts the following input properties:
- Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Object stringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Properties List<ApischemaSchemas Additional Properties Schema> - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Allow
Additional stringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Apischema
Id string - Array
Item List<ApischemaTypes Array Item Type> - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Composite
Types List<ApischemaComposite Type> - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes List<ApischemaConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Discriminators
List<Apischema
Discriminator> - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Object
Properties List<ApischemaObject Property> - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Unique
Items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Object stringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Properties []ApischemaSchemas Additional Properties Schema Args - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Allow
Additional stringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Apischema
Id string - Array
Item []ApischemaTypes Array Item Type Args - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Composite
Types []ApischemaComposite Type Args - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes []ApischemaConfigpb Attribute Args - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Discriminators
[]Apischema
Discriminator Args - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Object
Properties []ApischemaObject Property Args - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Unique
Items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
object_ stringkey_ action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
properties_ list(object)schemas - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow_
additional_ stringproperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema_
id string - array_
item_ list(object)types - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite_
types list(object) - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes list(object) - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators list(object)
- Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min_
items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object_
properties list(object) - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique_
items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Object StringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Properties List<ApischemaSchemas Additional Properties Schema> - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow
Additional StringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema
Id String - array
Item List<ApischemaTypes Array Item Type> - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite
Types List<ApischemaComposite Type> - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<ApischemaConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators
List<Apischema
Discriminator> - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Items String - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Items String - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object
Properties List<ApischemaObject Property> - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source String
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique
Items String - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Object stringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Properties ApischemaSchemas Additional Properties Schema[] - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow
Additional stringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema
Id string - array
Item ApischemaTypes Array Item Type[] - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite
Types ApischemaComposite Type[] - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes ApischemaConfigpb Attribute[] - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators
Apischema
Discriminator[] - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object
Properties ApischemaObject Property[] - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique
Items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type str
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
object_ strkey_ action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
properties_ Sequence[Apischemaschemas Additional Properties Schema Args] - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow_
additional_ strproperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema_
id str - array_
item_ Sequence[Apischematypes Array Item Type Args] - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite_
types Sequence[ApischemaComposite Type Args] - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes Sequence[ApischemaConfigpb Attribute Args] - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description str
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators
Sequence[Apischema
Discriminator Args] - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
items str - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min_
items str - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name str
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object_
properties Sequence[ApischemaObject Property Args] - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source str
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref str - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique_
items str - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid str
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Object StringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Properties List<Property Map>Schemas - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow
Additional StringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema
Id String - array
Item List<Property Map>Types - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite
Types List<Property Map> - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<Property Map> - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators List<Property Map>
- Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Items String - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Items String - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object
Properties List<Property Map> - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source String
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique
Items String - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Outputs
All input properties are implicitly available as output properties. Additionally, the Apischema resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Apischema Resource
Get an existing Apischema resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApischemaState, opts?: CustomResourceOptions): Apischema@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_object_key_action: Optional[str] = None,
additional_properties_schemas: Optional[Sequence[ApischemaAdditionalPropertiesSchemaArgs]] = None,
allow_additional_properties: Optional[str] = None,
apischema_id: Optional[str] = None,
array_item_types: Optional[Sequence[ApischemaArrayItemTypeArgs]] = None,
composite_types: Optional[Sequence[ApischemaCompositeTypeArgs]] = None,
configpb_attributes: Optional[Sequence[ApischemaConfigpbAttributeArgs]] = None,
description: Optional[str] = None,
discriminators: Optional[Sequence[ApischemaDiscriminatorArgs]] = None,
max_items: Optional[str] = None,
min_items: Optional[str] = None,
name: Optional[str] = None,
object_properties: Optional[Sequence[ApischemaObjectPropertyArgs]] = None,
source: Optional[str] = None,
tenant_ref: Optional[str] = None,
type: Optional[str] = None,
unique_items: Optional[str] = None,
uuid: Optional[str] = None) -> Apischemafunc GetApischema(ctx *Context, name string, id IDInput, state *ApischemaState, opts ...ResourceOption) (*Apischema, error)public static Apischema Get(string name, Input<string> id, ApischemaState? state, CustomResourceOptions? opts = null)public static Apischema get(String name, Output<String> id, ApischemaState state, CustomResourceOptions options)resources: _: type: avi:Apischema get: id: ${id}import {
to = avi_apischema.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Object stringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Properties List<ApischemaSchemas Additional Properties Schema> - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Allow
Additional stringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Apischema
Id string - Array
Item List<ApischemaTypes Array Item Type> - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Composite
Types List<ApischemaComposite Type> - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes List<ApischemaConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Discriminators
List<Apischema
Discriminator> - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Object
Properties List<ApischemaObject Property> - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Unique
Items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Object stringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Additional
Properties []ApischemaSchemas Additional Properties Schema Args - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Allow
Additional stringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Apischema
Id string - Array
Item []ApischemaTypes Array Item Type Args - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Composite
Types []ApischemaComposite Type Args - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes []ApischemaConfigpb Attribute Args - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Discriminators
[]Apischema
Discriminator Args - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Object
Properties []ApischemaObject Property Args - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Unique
Items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
object_ stringkey_ action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
properties_ list(object)schemas - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow_
additional_ stringproperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema_
id string - array_
item_ list(object)types - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite_
types list(object) - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes list(object) - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators list(object)
- Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min_
items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object_
properties list(object) - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique_
items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Object StringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Properties List<ApischemaSchemas Additional Properties Schema> - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow
Additional StringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema
Id String - array
Item List<ApischemaTypes Array Item Type> - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite
Types List<ApischemaComposite Type> - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<ApischemaConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators
List<Apischema
Discriminator> - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Items String - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Items String - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object
Properties List<ApischemaObject Property> - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source String
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique
Items String - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Object stringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Properties ApischemaSchemas Additional Properties Schema[] - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow
Additional stringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema
Id string - array
Item ApischemaTypes Array Item Type[] - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite
Types ApischemaComposite Type[] - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes ApischemaConfigpb Attribute[] - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description string
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators
Apischema
Discriminator[] - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Items string - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Items string - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object
Properties ApischemaObject Property[] - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source string
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref string - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique
Items string - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
object_ strkey_ action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional_
properties_ Sequence[Apischemaschemas Additional Properties Schema Args] - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow_
additional_ strproperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema_
id str - array_
item_ Sequence[Apischematypes Array Item Type Args] - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite_
types Sequence[ApischemaComposite Type Args] - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes Sequence[ApischemaConfigpb Attribute Args] - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description str
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators
Sequence[Apischema
Discriminator Args] - Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
items str - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min_
items str - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name str
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object_
properties Sequence[ApischemaObject Property Args] - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source str
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref str - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type str
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique_
items str - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid str
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Object StringKey Action - Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- additional
Properties List<Property Map>Schemas - Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- allow
Additional StringProperties - When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- apischema
Id String - array
Item List<Property Map>Types - If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- composite
Types List<Property Map> - Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<Property Map> - Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- description String
- Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- discriminators List<Property Map>
- Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Items String - Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Items String - Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- name String
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- object
Properties List<Property Map> - List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- source String
- Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- unique
Items String - If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Supporting Types
ApischemaAdditionalPropertiesSchema, ApischemaAdditionalPropertiesSchemaArgs
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum List<string>Values - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum []stringValues - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value string - min_
value string - schema_
ref string - string_
enum_ list(string)values - string_
format string - string_
max_ stringlength - string_
min_ stringlength - string_
pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value string - min
Value string - schema
Ref string - string
Enum string[]Values - string
Format string - string
Max stringLength - string
Min stringLength - string
Pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value str - min_
value str - schema_
ref str - string_
enum_ Sequence[str]values - string_
format str - string_
max_ strlength - string_
min_ strlength - string_
pattern str - type str
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ApischemaArrayItemType, ApischemaArrayItemTypeArgs
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum List<string>Values - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum []stringValues - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value string - min_
value string - schema_
ref string - string_
enum_ list(string)values - string_
format string - string_
max_ stringlength - string_
min_ stringlength - string_
pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value string - min
Value string - schema
Ref string - string
Enum string[]Values - string
Format string - string
Max stringLength - string
Min stringLength - string
Pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value str - min_
value str - schema_
ref str - string_
enum_ Sequence[str]values - string_
format str - string_
max_ strlength - string_
min_ strlength - string_
pattern str - type str
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ApischemaCompositeType, ApischemaCompositeTypeArgs
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum List<string>Values - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum []stringValues - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value string - min_
value string - schema_
ref string - string_
enum_ list(string)values - string_
format string - string_
max_ stringlength - string_
min_ stringlength - string_
pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value string - min
Value string - schema
Ref string - string
Enum string[]Values - string
Format string - string
Max stringLength - string
Min stringLength - string
Pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value str - min_
value str - schema_
ref str - string_
enum_ Sequence[str]values - string_
format str - string_
max_ strlength - string_
min_ strlength - string_
pattern str - type str
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ApischemaConfigpbAttribute, ApischemaConfigpbAttributeArgs
- created_
by string - version string
- created_
by str - version str
ApischemaDiscriminator, ApischemaDiscriminatorArgs
ApischemaDiscriminatorMapping, ApischemaDiscriminatorMappingArgs
- Discriminator
Key string - Schema
Ref string
- Discriminator
Key string - Schema
Ref string
- discriminator_
key string - schema_
ref string
- discriminator
Key String - schema
Ref String
- discriminator
Key string - schema
Ref string
- discriminator_
key str - schema_
ref str
- discriminator
Key String - schema
Ref String
ApischemaObjectProperty, ApischemaObjectPropertyArgs
- Name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Schemas
List<Apischema
Object Property Schema> - Access
Mode string - Deprecated string
- Nullable string
- Required string
- Name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Schemas
[]Apischema
Object Property Schema - Access
Mode string - Deprecated string
- Nullable string
- Required string
- name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- schemas list(object)
- access_
mode string - deprecated string
- nullable string
- required string
- name String
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- schemas
List<Apischema
Object Property Schema> - access
Mode String - deprecated String
- nullable String
- required String
- name string
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- schemas
Apischema
Object Property Schema[] - access
Mode string - deprecated string
- nullable string
- required string
- name str
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- schemas
Sequence[Apischema
Object Property Schema] - access_
mode str - deprecated str
- nullable str
- required str
- name String
- Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- schemas List<Property Map>
- access
Mode String - deprecated String
- nullable String
- required String
ApischemaObjectPropertySchema, ApischemaObjectPropertySchemaArgs
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum List<string>Values - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Max
Value string - Min
Value string - Schema
Ref string - String
Enum []stringValues - String
Format string - String
Max stringLength - String
Min stringLength - String
Pattern string - Type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value string - min_
value string - schema_
ref string - string_
enum_ list(string)values - string_
format string - string_
max_ stringlength - string_
min_ stringlength - string_
pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value string - min
Value string - schema
Ref string - string
Enum string[]Values - string
Format string - string
Max stringLength - string
Min stringLength - string
Pattern string - type string
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max_
value str - min_
value str - schema_
ref str - string_
enum_ Sequence[str]values - string_
format str - string_
max_ strlength - string_
min_ strlength - string_
pattern str - type str
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- max
Value String - min
Value String - schema
Ref String - string
Enum List<String>Values - string
Format String - string
Max StringLength - string
Min StringLength - string
Pattern String - type String
- The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Package Details
- Repository
- avi vmware/terraform-provider-avi
- License
- Notes
- This Pulumi package is based on the
aviTerraform Provider.
avi
Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware
published on Friday, Oct 23, 2026 by vmware