Class ApiSchema

Manages an API Schema within an API Management Service.

Example Usage

using System.IO;
using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleApi = Output.Create(Azure.ApiManagement.GetApi.InvokeAsync(new Azure.ApiManagement.GetApiArgs
    {
        Name = "search-api",
        ApiManagementName = "search-api-management",
        ResourceGroupName = "search-service",
        Revision = "2",
    }));
    var exampleApiSchema = new Azure.ApiManagement.ApiSchema("exampleApiSchema", new Azure.ApiManagement.ApiSchemaArgs
    {
        ApiName = exampleApi.Apply(exampleApi => exampleApi.Name),
        ApiManagementName = exampleApi.Apply(exampleApi => exampleApi.ApiManagementName),
        ResourceGroupName = exampleApi.Apply(exampleApi => exampleApi.ResourceGroupName),
        SchemaId = "example-sche,a",
        ContentType = "application/vnd.ms-azure-apim.xsd+xml",
        Value = File.ReadAllText("api_management_api_schema.xml"),
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ApiSchema

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class ApiSchema : CustomResource

Constructors

ApiSchema(String, ApiSchemaArgs, CustomResourceOptions)

Create a ApiSchema resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApiSchemaArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

ApiName

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.

Declaration

public Output<string> ApiName { get; }

Property Value

Type	Description
Output<System.String>

ContentType

The content type of the API Schema.

Declaration

public Output<string> ContentType { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SchemaId

A unique identifier for this API Schema. Changing this forces a new resource to be created.

Declaration

public Output<string> SchemaId { get; }

Property Value

Type	Description
Output<System.String>

Value

The JSON escaped string defining the document representing the Schema.

Declaration

public Output<string> Value { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ApiSchemaState, CustomResourceOptions)

Get an existing ApiSchema resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ApiSchema Get(string name, Input<string> id, ApiSchemaState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApiSchemaState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ApiSchema