ApiSchema

Manages an API Schema within an API Management Service.

Create a ApiSchema Resource

new ApiSchema(name: string, args: ApiSchemaArgs, opts?: CustomResourceOptions);

def ApiSchema(resource_name, opts=None, api_management_name=None, api_name=None, content_type=None, resource_group_name=None, schema_id=None, value=None, __props__=None);

func NewApiSchema(ctx *Context, name string, args ApiSchemaArgs, opts ...ResourceOption) (*ApiSchema, error)

public ApiSchema(string name, ApiSchemaArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

ApiSchema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ApiSchema resource accepts the following input properties:

ApiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
ApiName string: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
ContentType string: The content type of the API Schema.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
SchemaId string: A unique identifier for this API Schema. Changing this forces a new resource to be created.
Value string: The JSON escaped string defining the document representing the Schema.

ApiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
ApiName string: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
ContentType string: The content type of the API Schema.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
SchemaId string: A unique identifier for this API Schema. Changing this forces a new resource to be created.
Value string: The JSON escaped string defining the document representing the Schema.

apiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
apiName string: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
contentType string: The content type of the API Schema.
resourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
schemaId string: A unique identifier for this API Schema. Changing this forces a new resource to be created.
value string: The JSON escaped string defining the document representing the Schema.

api_management_name str: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
api_name str: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
content_type str: The content type of the API Schema.
resource_group_name str: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
schema_id str: A unique identifier for this API Schema. Changing this forces a new resource to be created.
value str: The JSON escaped string defining the document representing the Schema.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, content_type=None, resource_group_name=None, schema_id=None, value=None, __props__=None);

func 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)

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.

The following state arguments are supported:

ApiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
ApiName string: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
ContentType string: The content type of the API Schema.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
SchemaId string: A unique identifier for this API Schema. Changing this forces a new resource to be created.
Value string: The JSON escaped string defining the document representing the Schema.

ApiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
ApiName string: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
ContentType string: The content type of the API Schema.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
SchemaId string: A unique identifier for this API Schema. Changing this forces a new resource to be created.
Value string: The JSON escaped string defining the document representing the Schema.

apiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
apiName string: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
contentType string: The content type of the API Schema.
resourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
schemaId string: A unique identifier for this API Schema. Changing this forces a new resource to be created.
value string: The JSON escaped string defining the document representing the Schema.

api_management_name str: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
api_name str: The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
content_type str: The content type of the API Schema.
resource_group_name str: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
schema_id str: A unique identifier for this API Schema. Changing this forces a new resource to be created.
value str: The JSON escaped string defining the document representing the Schema.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud