azure-native.apimanagement.WorkspaceApiOperation
Explore with Pulumi AI
API Operation details. Azure REST API version: 2022-09-01-preview.
Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
Example Usage
ApiManagementCreateWorkspaceApiOperation
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workspaceApiOperation = new AzureNative.ApiManagement.WorkspaceApiOperation("workspaceApiOperation", new()
{
ApiId = "PetStoreTemplate2",
Description = "This can only be done by the logged in user.",
DisplayName = "createUser2",
Method = "POST",
OperationId = "newoperations",
Request = new AzureNative.ApiManagement.Inputs.RequestContractArgs
{
Description = "Created user object",
Headers = new() { },
QueryParameters = new() { },
Representations = new[]
{
new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
{
ContentType = "application/json",
SchemaId = "592f6c1d0af5840ca8897f0c",
TypeName = "User",
},
},
},
ResourceGroupName = "rg1",
Responses = new[]
{
new AzureNative.ApiManagement.Inputs.ResponseContractArgs
{
Description = "successful operation",
Headers = new() { },
Representations = new[]
{
new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
{
ContentType = "application/xml",
},
new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
{
ContentType = "application/json",
},
},
StatusCode = 200,
},
},
ServiceName = "apimService1",
TemplateParameters = new[] {},
UrlTemplate = "/user1",
WorkspaceId = "wks1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewWorkspaceApiOperation(ctx, "workspaceApiOperation", &apimanagement.WorkspaceApiOperationArgs{
ApiId: pulumi.String("PetStoreTemplate2"),
Description: pulumi.String("This can only be done by the logged in user."),
DisplayName: pulumi.String("createUser2"),
Method: pulumi.String("POST"),
OperationId: pulumi.String("newoperations"),
Request: &apimanagement.RequestContractArgs{
Description: pulumi.String("Created user object"),
Headers: apimanagement.ParameterContractArray{},
QueryParameters: apimanagement.ParameterContractArray{},
Representations: apimanagement.RepresentationContractArray{
&apimanagement.RepresentationContractArgs{
ContentType: pulumi.String("application/json"),
SchemaId: pulumi.String("592f6c1d0af5840ca8897f0c"),
TypeName: pulumi.String("User"),
},
},
},
ResourceGroupName: pulumi.String("rg1"),
Responses: apimanagement.ResponseContractArray{
&apimanagement.ResponseContractArgs{
Description: pulumi.String("successful operation"),
Headers: apimanagement.ParameterContractArray{},
Representations: apimanagement.RepresentationContractArray{
&apimanagement.RepresentationContractArgs{
ContentType: pulumi.String("application/xml"),
},
&apimanagement.RepresentationContractArgs{
ContentType: pulumi.String("application/json"),
},
},
StatusCode: pulumi.Int(200),
},
},
ServiceName: pulumi.String("apimService1"),
TemplateParameters: apimanagement.ParameterContractArray{},
UrlTemplate: pulumi.String("/user1"),
WorkspaceId: pulumi.String("wks1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceApiOperation;
import com.pulumi.azurenative.apimanagement.WorkspaceApiOperationArgs;
import com.pulumi.azurenative.apimanagement.inputs.RequestContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.ResponseContractArgs;
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 workspaceApiOperation = new WorkspaceApiOperation("workspaceApiOperation", WorkspaceApiOperationArgs.builder()
.apiId("PetStoreTemplate2")
.description("This can only be done by the logged in user.")
.displayName("createUser2")
.method("POST")
.operationId("newoperations")
.request(RequestContractArgs.builder()
.description("Created user object")
.headers()
.queryParameters()
.representations(RepresentationContractArgs.builder()
.contentType("application/json")
.schemaId("592f6c1d0af5840ca8897f0c")
.typeName("User")
.build())
.build())
.resourceGroupName("rg1")
.responses(ResponseContractArgs.builder()
.description("successful operation")
.headers()
.representations(
RepresentationContractArgs.builder()
.contentType("application/xml")
.build(),
RepresentationContractArgs.builder()
.contentType("application/json")
.build())
.statusCode(200)
.build())
.serviceName("apimService1")
.templateParameters()
.urlTemplate("/user1")
.workspaceId("wks1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
workspace_api_operation = azure_native.apimanagement.WorkspaceApiOperation("workspaceApiOperation",
api_id="PetStoreTemplate2",
description="This can only be done by the logged in user.",
display_name="createUser2",
method="POST",
operation_id="newoperations",
request={
"description": "Created user object",
"headers": [],
"query_parameters": [],
"representations": [{
"content_type": "application/json",
"schema_id": "592f6c1d0af5840ca8897f0c",
"type_name": "User",
}],
},
resource_group_name="rg1",
responses=[{
"description": "successful operation",
"headers": [],
"representations": [
{
"content_type": "application/xml",
},
{
"content_type": "application/json",
},
],
"status_code": 200,
}],
service_name="apimService1",
template_parameters=[],
url_template="/user1",
workspace_id="wks1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const workspaceApiOperation = new azure_native.apimanagement.WorkspaceApiOperation("workspaceApiOperation", {
apiId: "PetStoreTemplate2",
description: "This can only be done by the logged in user.",
displayName: "createUser2",
method: "POST",
operationId: "newoperations",
request: {
description: "Created user object",
headers: [],
queryParameters: [],
representations: [{
contentType: "application/json",
schemaId: "592f6c1d0af5840ca8897f0c",
typeName: "User",
}],
},
resourceGroupName: "rg1",
responses: [{
description: "successful operation",
headers: [],
representations: [
{
contentType: "application/xml",
},
{
contentType: "application/json",
},
],
statusCode: 200,
}],
serviceName: "apimService1",
templateParameters: [],
urlTemplate: "/user1",
workspaceId: "wks1",
});
resources:
workspaceApiOperation:
type: azure-native:apimanagement:WorkspaceApiOperation
properties:
apiId: PetStoreTemplate2
description: This can only be done by the logged in user.
displayName: createUser2
method: POST
operationId: newoperations
request:
description: Created user object
headers: []
queryParameters: []
representations:
- contentType: application/json
schemaId: 592f6c1d0af5840ca8897f0c
typeName: User
resourceGroupName: rg1
responses:
- description: successful operation
headers: []
representations:
- contentType: application/xml
- contentType: application/json
statusCode: 200
serviceName: apimService1
templateParameters: []
urlTemplate: /user1
workspaceId: wks1
Create WorkspaceApiOperation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkspaceApiOperation(name: string, args: WorkspaceApiOperationArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceApiOperation(resource_name: str,
args: WorkspaceApiOperationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WorkspaceApiOperation(resource_name: str,
opts: Optional[ResourceOptions] = None,
service_name: Optional[str] = None,
display_name: Optional[str] = None,
method: Optional[str] = None,
resource_group_name: Optional[str] = None,
api_id: Optional[str] = None,
url_template: Optional[str] = None,
workspace_id: Optional[str] = None,
description: Optional[str] = None,
operation_id: Optional[str] = None,
policies: Optional[str] = None,
request: Optional[RequestContractArgs] = None,
responses: Optional[Sequence[ResponseContractArgs]] = None,
template_parameters: Optional[Sequence[ParameterContractArgs]] = None)
func NewWorkspaceApiOperation(ctx *Context, name string, args WorkspaceApiOperationArgs, opts ...ResourceOption) (*WorkspaceApiOperation, error)
public WorkspaceApiOperation(string name, WorkspaceApiOperationArgs args, CustomResourceOptions? opts = null)
public WorkspaceApiOperation(String name, WorkspaceApiOperationArgs args)
public WorkspaceApiOperation(String name, WorkspaceApiOperationArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:WorkspaceApiOperation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkspaceApiOperationArgs
- 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 WorkspaceApiOperationArgs
- 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 WorkspaceApiOperationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceApiOperationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceApiOperationArgs
- 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 workspaceApiOperationResource = new AzureNative.ApiManagement.WorkspaceApiOperation("workspaceApiOperationResource", new()
{
ServiceName = "string",
DisplayName = "string",
Method = "string",
ResourceGroupName = "string",
ApiId = "string",
UrlTemplate = "string",
WorkspaceId = "string",
Description = "string",
OperationId = "string",
Policies = "string",
Request = new AzureNative.ApiManagement.Inputs.RequestContractArgs
{
Description = "string",
Headers = new[]
{
new AzureNative.ApiManagement.Inputs.ParameterContractArgs
{
Name = "string",
Type = "string",
DefaultValue = "string",
Description = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
Required = false,
SchemaId = "string",
TypeName = "string",
Values = new[]
{
"string",
},
},
},
QueryParameters = new[]
{
new AzureNative.ApiManagement.Inputs.ParameterContractArgs
{
Name = "string",
Type = "string",
DefaultValue = "string",
Description = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
Required = false,
SchemaId = "string",
TypeName = "string",
Values = new[]
{
"string",
},
},
},
Representations = new[]
{
new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
{
ContentType = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
FormParameters = new[]
{
new AzureNative.ApiManagement.Inputs.ParameterContractArgs
{
Name = "string",
Type = "string",
DefaultValue = "string",
Description = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
Required = false,
SchemaId = "string",
TypeName = "string",
Values = new[]
{
"string",
},
},
},
SchemaId = "string",
TypeName = "string",
},
},
},
Responses = new[]
{
new AzureNative.ApiManagement.Inputs.ResponseContractArgs
{
StatusCode = 0,
Description = "string",
Headers = new[]
{
new AzureNative.ApiManagement.Inputs.ParameterContractArgs
{
Name = "string",
Type = "string",
DefaultValue = "string",
Description = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
Required = false,
SchemaId = "string",
TypeName = "string",
Values = new[]
{
"string",
},
},
},
Representations = new[]
{
new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
{
ContentType = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
FormParameters = new[]
{
new AzureNative.ApiManagement.Inputs.ParameterContractArgs
{
Name = "string",
Type = "string",
DefaultValue = "string",
Description = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
Required = false,
SchemaId = "string",
TypeName = "string",
Values = new[]
{
"string",
},
},
},
SchemaId = "string",
TypeName = "string",
},
},
},
},
TemplateParameters = new[]
{
new AzureNative.ApiManagement.Inputs.ParameterContractArgs
{
Name = "string",
Type = "string",
DefaultValue = "string",
Description = "string",
Examples =
{
{ "string", new AzureNative.ApiManagement.Inputs.ParameterExampleContractArgs
{
Description = "string",
ExternalValue = "string",
Summary = "string",
Value = "any",
} },
},
Required = false,
SchemaId = "string",
TypeName = "string",
Values = new[]
{
"string",
},
},
},
});
example, err := apimanagement.NewWorkspaceApiOperation(ctx, "workspaceApiOperationResource", &apimanagement.WorkspaceApiOperationArgs{
ServiceName: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Method: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ApiId: pulumi.String("string"),
UrlTemplate: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
Description: pulumi.String("string"),
OperationId: pulumi.String("string"),
Policies: pulumi.String("string"),
Request: &apimanagement.RequestContractArgs{
Description: pulumi.String("string"),
Headers: apimanagement.ParameterContractArray{
&apimanagement.ParameterContractArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
Required: pulumi.Bool(false),
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
QueryParameters: apimanagement.ParameterContractArray{
&apimanagement.ParameterContractArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
Required: pulumi.Bool(false),
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Representations: apimanagement.RepresentationContractArray{
&apimanagement.RepresentationContractArgs{
ContentType: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
FormParameters: apimanagement.ParameterContractArray{
&apimanagement.ParameterContractArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
Required: pulumi.Bool(false),
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
},
},
},
Responses: apimanagement.ResponseContractArray{
&apimanagement.ResponseContractArgs{
StatusCode: pulumi.Int(0),
Description: pulumi.String("string"),
Headers: apimanagement.ParameterContractArray{
&apimanagement.ParameterContractArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
Required: pulumi.Bool(false),
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Representations: apimanagement.RepresentationContractArray{
&apimanagement.RepresentationContractArgs{
ContentType: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
FormParameters: apimanagement.ParameterContractArray{
&apimanagement.ParameterContractArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
Required: pulumi.Bool(false),
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
},
},
},
},
TemplateParameters: apimanagement.ParameterContractArray{
&apimanagement.ParameterContractArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Examples: apimanagement.ParameterExampleContractMap{
"string": &apimanagement.ParameterExampleContractArgs{
Description: pulumi.String("string"),
ExternalValue: pulumi.String("string"),
Summary: pulumi.String("string"),
Value: pulumi.Any("any"),
},
},
Required: pulumi.Bool(false),
SchemaId: pulumi.String("string"),
TypeName: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})
var workspaceApiOperationResource = new WorkspaceApiOperation("workspaceApiOperationResource", WorkspaceApiOperationArgs.builder()
.serviceName("string")
.displayName("string")
.method("string")
.resourceGroupName("string")
.apiId("string")
.urlTemplate("string")
.workspaceId("string")
.description("string")
.operationId("string")
.policies("string")
.request(RequestContractArgs.builder()
.description("string")
.headers(ParameterContractArgs.builder()
.name("string")
.type("string")
.defaultValue("string")
.description("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.required(false)
.schemaId("string")
.typeName("string")
.values("string")
.build())
.queryParameters(ParameterContractArgs.builder()
.name("string")
.type("string")
.defaultValue("string")
.description("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.required(false)
.schemaId("string")
.typeName("string")
.values("string")
.build())
.representations(RepresentationContractArgs.builder()
.contentType("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.formParameters(ParameterContractArgs.builder()
.name("string")
.type("string")
.defaultValue("string")
.description("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.required(false)
.schemaId("string")
.typeName("string")
.values("string")
.build())
.schemaId("string")
.typeName("string")
.build())
.build())
.responses(ResponseContractArgs.builder()
.statusCode(0)
.description("string")
.headers(ParameterContractArgs.builder()
.name("string")
.type("string")
.defaultValue("string")
.description("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.required(false)
.schemaId("string")
.typeName("string")
.values("string")
.build())
.representations(RepresentationContractArgs.builder()
.contentType("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.formParameters(ParameterContractArgs.builder()
.name("string")
.type("string")
.defaultValue("string")
.description("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.required(false)
.schemaId("string")
.typeName("string")
.values("string")
.build())
.schemaId("string")
.typeName("string")
.build())
.build())
.templateParameters(ParameterContractArgs.builder()
.name("string")
.type("string")
.defaultValue("string")
.description("string")
.examples(Map.of("string", Map.ofEntries(
Map.entry("description", "string"),
Map.entry("externalValue", "string"),
Map.entry("summary", "string"),
Map.entry("value", "any")
)))
.required(false)
.schemaId("string")
.typeName("string")
.values("string")
.build())
.build());
workspace_api_operation_resource = azure_native.apimanagement.WorkspaceApiOperation("workspaceApiOperationResource",
service_name="string",
display_name="string",
method="string",
resource_group_name="string",
api_id="string",
url_template="string",
workspace_id="string",
description="string",
operation_id="string",
policies="string",
request={
"description": "string",
"headers": [{
"name": "string",
"type": "string",
"defaultValue": "string",
"description": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"required": False,
"schemaId": "string",
"typeName": "string",
"values": ["string"],
}],
"queryParameters": [{
"name": "string",
"type": "string",
"defaultValue": "string",
"description": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"required": False,
"schemaId": "string",
"typeName": "string",
"values": ["string"],
}],
"representations": [{
"contentType": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"formParameters": [{
"name": "string",
"type": "string",
"defaultValue": "string",
"description": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"required": False,
"schemaId": "string",
"typeName": "string",
"values": ["string"],
}],
"schemaId": "string",
"typeName": "string",
}],
},
responses=[{
"statusCode": 0,
"description": "string",
"headers": [{
"name": "string",
"type": "string",
"defaultValue": "string",
"description": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"required": False,
"schemaId": "string",
"typeName": "string",
"values": ["string"],
}],
"representations": [{
"contentType": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"formParameters": [{
"name": "string",
"type": "string",
"defaultValue": "string",
"description": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"required": False,
"schemaId": "string",
"typeName": "string",
"values": ["string"],
}],
"schemaId": "string",
"typeName": "string",
}],
}],
template_parameters=[{
"name": "string",
"type": "string",
"defaultValue": "string",
"description": "string",
"examples": {
"string": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": "any",
},
},
"required": False,
"schemaId": "string",
"typeName": "string",
"values": ["string"],
}])
const workspaceApiOperationResource = new azure_native.apimanagement.WorkspaceApiOperation("workspaceApiOperationResource", {
serviceName: "string",
displayName: "string",
method: "string",
resourceGroupName: "string",
apiId: "string",
urlTemplate: "string",
workspaceId: "string",
description: "string",
operationId: "string",
policies: "string",
request: {
description: "string",
headers: [{
name: "string",
type: "string",
defaultValue: "string",
description: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
required: false,
schemaId: "string",
typeName: "string",
values: ["string"],
}],
queryParameters: [{
name: "string",
type: "string",
defaultValue: "string",
description: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
required: false,
schemaId: "string",
typeName: "string",
values: ["string"],
}],
representations: [{
contentType: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
formParameters: [{
name: "string",
type: "string",
defaultValue: "string",
description: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
required: false,
schemaId: "string",
typeName: "string",
values: ["string"],
}],
schemaId: "string",
typeName: "string",
}],
},
responses: [{
statusCode: 0,
description: "string",
headers: [{
name: "string",
type: "string",
defaultValue: "string",
description: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
required: false,
schemaId: "string",
typeName: "string",
values: ["string"],
}],
representations: [{
contentType: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
formParameters: [{
name: "string",
type: "string",
defaultValue: "string",
description: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
required: false,
schemaId: "string",
typeName: "string",
values: ["string"],
}],
schemaId: "string",
typeName: "string",
}],
}],
templateParameters: [{
name: "string",
type: "string",
defaultValue: "string",
description: "string",
examples: {
string: {
description: "string",
externalValue: "string",
summary: "string",
value: "any",
},
},
required: false,
schemaId: "string",
typeName: "string",
values: ["string"],
}],
});
type: azure-native:apimanagement:WorkspaceApiOperation
properties:
apiId: string
description: string
displayName: string
method: string
operationId: string
policies: string
request:
description: string
headers:
- defaultValue: string
description: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
name: string
required: false
schemaId: string
type: string
typeName: string
values:
- string
queryParameters:
- defaultValue: string
description: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
name: string
required: false
schemaId: string
type: string
typeName: string
values:
- string
representations:
- contentType: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
formParameters:
- defaultValue: string
description: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
name: string
required: false
schemaId: string
type: string
typeName: string
values:
- string
schemaId: string
typeName: string
resourceGroupName: string
responses:
- description: string
headers:
- defaultValue: string
description: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
name: string
required: false
schemaId: string
type: string
typeName: string
values:
- string
representations:
- contentType: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
formParameters:
- defaultValue: string
description: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
name: string
required: false
schemaId: string
type: string
typeName: string
values:
- string
schemaId: string
typeName: string
statusCode: 0
serviceName: string
templateParameters:
- defaultValue: string
description: string
examples:
string:
description: string
externalValue: string
summary: string
value: any
name: string
required: false
schemaId: string
type: string
typeName: string
values:
- string
urlTemplate: string
workspaceId: string
WorkspaceApiOperation Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The WorkspaceApiOperation resource accepts the following input properties:
- Api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Display
Name string - Operation Name.
- Method string
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Url
Template string - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Description string
- Description of the operation. May include HTML formatting tags.
- Operation
Id string - Operation identifier within an API. Must be unique in the current API Management service instance.
- Policies string
- Operation Policies
- Request
Pulumi.
Azure Native. Api Management. Inputs. Request Contract - An entity containing request details.
- Responses
List<Pulumi.
Azure Native. Api Management. Inputs. Response Contract> - Array of Operation responses.
- Template
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract> - Collection of URL template parameters.
- Api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Display
Name string - Operation Name.
- Method string
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Url
Template string - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Description string
- Description of the operation. May include HTML formatting tags.
- Operation
Id string - Operation identifier within an API. Must be unique in the current API Management service instance.
- Policies string
- Operation Policies
- Request
Request
Contract Args - An entity containing request details.
- Responses
[]Response
Contract Args - Array of Operation responses.
- Template
Parameters []ParameterContract Args - Collection of URL template parameters.
- api
Id String - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- display
Name String - Operation Name.
- method String
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- url
Template String - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- description String
- Description of the operation. May include HTML formatting tags.
- operation
Id String - Operation identifier within an API. Must be unique in the current API Management service instance.
- policies String
- Operation Policies
- request
Request
Contract - An entity containing request details.
- responses
List<Response
Contract> - Array of Operation responses.
- template
Parameters List<ParameterContract> - Collection of URL template parameters.
- api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- display
Name string - Operation Name.
- method string
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- url
Template string - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- description string
- Description of the operation. May include HTML formatting tags.
- operation
Id string - Operation identifier within an API. Must be unique in the current API Management service instance.
- policies string
- Operation Policies
- request
Request
Contract - An entity containing request details.
- responses
Response
Contract[] - Array of Operation responses.
- template
Parameters ParameterContract[] - Collection of URL template parameters.
- api_
id str - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- display_
name str - Operation Name.
- method str
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- url_
template str - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- workspace_
id str - Workspace identifier. Must be unique in the current API Management service instance.
- description str
- Description of the operation. May include HTML formatting tags.
- operation_
id str - Operation identifier within an API. Must be unique in the current API Management service instance.
- policies str
- Operation Policies
- request
Request
Contract Args - An entity containing request details.
- responses
Sequence[Response
Contract Args] - Array of Operation responses.
- template_
parameters Sequence[ParameterContract Args] - Collection of URL template parameters.
- api
Id String - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- display
Name String - Operation Name.
- method String
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- url
Template String - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- description String
- Description of the operation. May include HTML formatting tags.
- operation
Id String - Operation identifier within an API. Must be unique in the current API Management service instance.
- policies String
- Operation Policies
- request Property Map
- An entity containing request details.
- responses List<Property Map>
- Array of Operation responses.
- template
Parameters List<Property Map> - Collection of URL template parameters.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkspaceApiOperation resource produces the following output properties:
Supporting Types
ParameterContract, ParameterContractArgs
- Name string
- Parameter name.
- Type string
- Parameter type.
- Default
Value string - Default parameter value.
- Description string
- Parameter description.
- Examples
Dictionary<string, Pulumi.
Azure Native. Api Management. Inputs. Parameter Example Contract> - Exampled defined for the parameter.
- Required bool
- Specifies whether parameter is required or not.
- Schema
Id string - Schema identifier.
- Type
Name string - Type name defined by the schema.
- Values List<string>
- Parameter values.
- Name string
- Parameter name.
- Type string
- Parameter type.
- Default
Value string - Default parameter value.
- Description string
- Parameter description.
- Examples
map[string]Parameter
Example Contract - Exampled defined for the parameter.
- Required bool
- Specifies whether parameter is required or not.
- Schema
Id string - Schema identifier.
- Type
Name string - Type name defined by the schema.
- Values []string
- Parameter values.
- name String
- Parameter name.
- type String
- Parameter type.
- default
Value String - Default parameter value.
- description String
- Parameter description.
- examples
Map<String,Parameter
Example Contract> - Exampled defined for the parameter.
- required Boolean
- Specifies whether parameter is required or not.
- schema
Id String - Schema identifier.
- type
Name String - Type name defined by the schema.
- values List<String>
- Parameter values.
- name string
- Parameter name.
- type string
- Parameter type.
- default
Value string - Default parameter value.
- description string
- Parameter description.
- examples
{[key: string]: Parameter
Example Contract} - Exampled defined for the parameter.
- required boolean
- Specifies whether parameter is required or not.
- schema
Id string - Schema identifier.
- type
Name string - Type name defined by the schema.
- values string[]
- Parameter values.
- name str
- Parameter name.
- type str
- Parameter type.
- default_
value str - Default parameter value.
- description str
- Parameter description.
- examples
Mapping[str, Parameter
Example Contract] - Exampled defined for the parameter.
- required bool
- Specifies whether parameter is required or not.
- schema_
id str - Schema identifier.
- type_
name str - Type name defined by the schema.
- values Sequence[str]
- Parameter values.
- name String
- Parameter name.
- type String
- Parameter type.
- default
Value String - Default parameter value.
- description String
- Parameter description.
- examples Map<Property Map>
- Exampled defined for the parameter.
- required Boolean
- Specifies whether parameter is required or not.
- schema
Id String - Schema identifier.
- type
Name String - Type name defined by the schema.
- values List<String>
- Parameter values.
ParameterContractResponse, ParameterContractResponseArgs
- Name string
- Parameter name.
- Type string
- Parameter type.
- Default
Value string - Default parameter value.
- Description string
- Parameter description.
- Examples
Dictionary<string, Pulumi.
Azure Native. Api Management. Inputs. Parameter Example Contract Response> - Exampled defined for the parameter.
- Required bool
- Specifies whether parameter is required or not.
- Schema
Id string - Schema identifier.
- Type
Name string - Type name defined by the schema.
- Values List<string>
- Parameter values.
- Name string
- Parameter name.
- Type string
- Parameter type.
- Default
Value string - Default parameter value.
- Description string
- Parameter description.
- Examples
map[string]Parameter
Example Contract Response - Exampled defined for the parameter.
- Required bool
- Specifies whether parameter is required or not.
- Schema
Id string - Schema identifier.
- Type
Name string - Type name defined by the schema.
- Values []string
- Parameter values.
- name String
- Parameter name.
- type String
- Parameter type.
- default
Value String - Default parameter value.
- description String
- Parameter description.
- examples
Map<String,Parameter
Example Contract Response> - Exampled defined for the parameter.
- required Boolean
- Specifies whether parameter is required or not.
- schema
Id String - Schema identifier.
- type
Name String - Type name defined by the schema.
- values List<String>
- Parameter values.
- name string
- Parameter name.
- type string
- Parameter type.
- default
Value string - Default parameter value.
- description string
- Parameter description.
- examples
{[key: string]: Parameter
Example Contract Response} - Exampled defined for the parameter.
- required boolean
- Specifies whether parameter is required or not.
- schema
Id string - Schema identifier.
- type
Name string - Type name defined by the schema.
- values string[]
- Parameter values.
- name str
- Parameter name.
- type str
- Parameter type.
- default_
value str - Default parameter value.
- description str
- Parameter description.
- examples
Mapping[str, Parameter
Example Contract Response] - Exampled defined for the parameter.
- required bool
- Specifies whether parameter is required or not.
- schema_
id str - Schema identifier.
- type_
name str - Type name defined by the schema.
- values Sequence[str]
- Parameter values.
- name String
- Parameter name.
- type String
- Parameter type.
- default
Value String - Default parameter value.
- description String
- Parameter description.
- examples Map<Property Map>
- Exampled defined for the parameter.
- required Boolean
- Specifies whether parameter is required or not.
- schema
Id String - Schema identifier.
- type
Name String - Type name defined by the schema.
- values List<String>
- Parameter values.
ParameterExampleContract, ParameterExampleContractArgs
- Description string
- Long description for the example
- External
Value string - A URL that points to the literal example
- Summary string
- Short description for the example
- Value object
- Example value. May be a primitive value, or an object.
- Description string
- Long description for the example
- External
Value string - A URL that points to the literal example
- Summary string
- Short description for the example
- Value interface{}
- Example value. May be a primitive value, or an object.
- description String
- Long description for the example
- external
Value String - A URL that points to the literal example
- summary String
- Short description for the example
- value Object
- Example value. May be a primitive value, or an object.
- description string
- Long description for the example
- external
Value string - A URL that points to the literal example
- summary string
- Short description for the example
- value any
- Example value. May be a primitive value, or an object.
- description str
- Long description for the example
- external_
value str - A URL that points to the literal example
- summary str
- Short description for the example
- value Any
- Example value. May be a primitive value, or an object.
- description String
- Long description for the example
- external
Value String - A URL that points to the literal example
- summary String
- Short description for the example
- value Any
- Example value. May be a primitive value, or an object.
ParameterExampleContractResponse, ParameterExampleContractResponseArgs
- Description string
- Long description for the example
- External
Value string - A URL that points to the literal example
- Summary string
- Short description for the example
- Value object
- Example value. May be a primitive value, or an object.
- Description string
- Long description for the example
- External
Value string - A URL that points to the literal example
- Summary string
- Short description for the example
- Value interface{}
- Example value. May be a primitive value, or an object.
- description String
- Long description for the example
- external
Value String - A URL that points to the literal example
- summary String
- Short description for the example
- value Object
- Example value. May be a primitive value, or an object.
- description string
- Long description for the example
- external
Value string - A URL that points to the literal example
- summary string
- Short description for the example
- value any
- Example value. May be a primitive value, or an object.
- description str
- Long description for the example
- external_
value str - A URL that points to the literal example
- summary str
- Short description for the example
- value Any
- Example value. May be a primitive value, or an object.
- description String
- Long description for the example
- external
Value String - A URL that points to the literal example
- summary String
- Short description for the example
- value Any
- Example value. May be a primitive value, or an object.
RepresentationContract, RepresentationContractArgs
- Content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- Examples
Dictionary<string, Pulumi.
Azure Native. Api Management. Inputs. Parameter Example Contract> - Exampled defined for the representation.
- Form
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- Schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- Examples
map[string]Parameter
Example Contract - Exampled defined for the representation.
- Form
Parameters []ParameterContract - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- Schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type String - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
Map<String,Parameter
Example Contract> - Exampled defined for the representation.
- form
Parameters List<ParameterContract> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id String - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name String - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
{[key: string]: Parameter
Example Contract} - Exampled defined for the representation.
- form
Parameters ParameterContract[] - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content_
type str - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
Mapping[str, Parameter
Example Contract] - Exampled defined for the representation.
- form_
parameters Sequence[ParameterContract] - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema_
id str - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type_
name str - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type String - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples Map<Property Map>
- Exampled defined for the representation.
- form
Parameters List<Property Map> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id String - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name String - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
RepresentationContractResponse, RepresentationContractResponseArgs
- Content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- Examples
Dictionary<string, Pulumi.
Azure Native. Api Management. Inputs. Parameter Example Contract Response> - Exampled defined for the representation.
- Form
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- Schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- Examples
map[string]Parameter
Example Contract Response - Exampled defined for the representation.
- Form
Parameters []ParameterContract Response - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- Schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type String - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
Map<String,Parameter
Example Contract Response> - Exampled defined for the representation.
- form
Parameters List<ParameterContract Response> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id String - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name String - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
{[key: string]: Parameter
Example Contract Response} - Exampled defined for the representation.
- form
Parameters ParameterContract Response[] - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content_
type str - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
Mapping[str, Parameter
Example Contract Response] - Exampled defined for the representation.
- form_
parameters Sequence[ParameterContract Response] - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema_
id str - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type_
name str - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type String - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples Map<Property Map>
- Exampled defined for the representation.
- form
Parameters List<Property Map> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id String - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name String - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
RequestContract, RequestContractArgs
- Description string
- Operation request description.
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Parameter Contract> - Collection of operation request headers.
- Query
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract> - Collection of operation request query parameters.
- Representations
List<Pulumi.
Azure Native. Api Management. Inputs. Representation Contract> - Collection of operation request representations.
- Description string
- Operation request description.
- Headers
[]Parameter
Contract - Collection of operation request headers.
- Query
Parameters []ParameterContract - Collection of operation request query parameters.
- Representations
[]Representation
Contract - Collection of operation request representations.
- description String
- Operation request description.
- headers
List<Parameter
Contract> - Collection of operation request headers.
- query
Parameters List<ParameterContract> - Collection of operation request query parameters.
- representations
List<Representation
Contract> - Collection of operation request representations.
- description string
- Operation request description.
- headers
Parameter
Contract[] - Collection of operation request headers.
- query
Parameters ParameterContract[] - Collection of operation request query parameters.
- representations
Representation
Contract[] - Collection of operation request representations.
- description str
- Operation request description.
- headers
Sequence[Parameter
Contract] - Collection of operation request headers.
- query_
parameters Sequence[ParameterContract] - Collection of operation request query parameters.
- representations
Sequence[Representation
Contract] - Collection of operation request representations.
- description String
- Operation request description.
- headers List<Property Map>
- Collection of operation request headers.
- query
Parameters List<Property Map> - Collection of operation request query parameters.
- representations List<Property Map>
- Collection of operation request representations.
RequestContractResponse, RequestContractResponseArgs
- Description string
- Operation request description.
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of operation request headers.
- Query
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of operation request query parameters.
- Representations
List<Pulumi.
Azure Native. Api Management. Inputs. Representation Contract Response> - Collection of operation request representations.
- Description string
- Operation request description.
- Headers
[]Parameter
Contract Response - Collection of operation request headers.
- Query
Parameters []ParameterContract Response - Collection of operation request query parameters.
- Representations
[]Representation
Contract Response - Collection of operation request representations.
- description String
- Operation request description.
- headers
List<Parameter
Contract Response> - Collection of operation request headers.
- query
Parameters List<ParameterContract Response> - Collection of operation request query parameters.
- representations
List<Representation
Contract Response> - Collection of operation request representations.
- description string
- Operation request description.
- headers
Parameter
Contract Response[] - Collection of operation request headers.
- query
Parameters ParameterContract Response[] - Collection of operation request query parameters.
- representations
Representation
Contract Response[] - Collection of operation request representations.
- description str
- Operation request description.
- headers
Sequence[Parameter
Contract Response] - Collection of operation request headers.
- query_
parameters Sequence[ParameterContract Response] - Collection of operation request query parameters.
- representations
Sequence[Representation
Contract Response] - Collection of operation request representations.
- description String
- Operation request description.
- headers List<Property Map>
- Collection of operation request headers.
- query
Parameters List<Property Map> - Collection of operation request query parameters.
- representations List<Property Map>
- Collection of operation request representations.
ResponseContract, ResponseContractArgs
- Status
Code int - Operation response HTTP status code.
- Description string
- Operation response description.
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Parameter Contract> - Collection of operation response headers.
- Representations
List<Pulumi.
Azure Native. Api Management. Inputs. Representation Contract> - Collection of operation response representations.
- Status
Code int - Operation response HTTP status code.
- Description string
- Operation response description.
- Headers
[]Parameter
Contract - Collection of operation response headers.
- Representations
[]Representation
Contract - Collection of operation response representations.
- status
Code Integer - Operation response HTTP status code.
- description String
- Operation response description.
- headers
List<Parameter
Contract> - Collection of operation response headers.
- representations
List<Representation
Contract> - Collection of operation response representations.
- status
Code number - Operation response HTTP status code.
- description string
- Operation response description.
- headers
Parameter
Contract[] - Collection of operation response headers.
- representations
Representation
Contract[] - Collection of operation response representations.
- status_
code int - Operation response HTTP status code.
- description str
- Operation response description.
- headers
Sequence[Parameter
Contract] - Collection of operation response headers.
- representations
Sequence[Representation
Contract] - Collection of operation response representations.
- status
Code Number - Operation response HTTP status code.
- description String
- Operation response description.
- headers List<Property Map>
- Collection of operation response headers.
- representations List<Property Map>
- Collection of operation response representations.
ResponseContractResponse, ResponseContractResponseArgs
- Status
Code int - Operation response HTTP status code.
- Description string
- Operation response description.
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of operation response headers.
- Representations
List<Pulumi.
Azure Native. Api Management. Inputs. Representation Contract Response> - Collection of operation response representations.
- Status
Code int - Operation response HTTP status code.
- Description string
- Operation response description.
- Headers
[]Parameter
Contract Response - Collection of operation response headers.
- Representations
[]Representation
Contract Response - Collection of operation response representations.
- status
Code Integer - Operation response HTTP status code.
- description String
- Operation response description.
- headers
List<Parameter
Contract Response> - Collection of operation response headers.
- representations
List<Representation
Contract Response> - Collection of operation response representations.
- status
Code number - Operation response HTTP status code.
- description string
- Operation response description.
- headers
Parameter
Contract Response[] - Collection of operation response headers.
- representations
Representation
Contract Response[] - Collection of operation response representations.
- status_
code int - Operation response HTTP status code.
- description str
- Operation response description.
- headers
Sequence[Parameter
Contract Response] - Collection of operation response headers.
- representations
Sequence[Representation
Contract Response] - Collection of operation response representations.
- status
Code Number - Operation response HTTP status code.
- description String
- Operation response description.
- headers List<Property Map>
- Collection of operation response headers.
- representations List<Property Map>
- Collection of operation response representations.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:WorkspaceApiOperation newoperations /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0