com.pulumi.azurenative.apimanagement.ApiSchema Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.apimanagement;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.apimanagement.ApiSchemaArgs;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Object;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* API Schema Contract details.
* Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
*
* Other available API versions: 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
*
* ## Example Usage
* ### ApiManagementCreateApiSchema
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apimanagement.ApiSchema;
* import com.pulumi.azurenative.apimanagement.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 apiSchema = new ApiSchema("apiSchema", ApiSchemaArgs.builder()
* .apiId("59d6bb8f1f7fab13dc67ec9b")
* .contentType("application/vnd.ms-azure-apim.xsd+xml")
* .resourceGroupName("rg1")
* .schemaId("ec12520d-9d48-4e7b-8f39-698ca2ac63f1")
* .serviceName("apimService1")
* .value("""
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* """)
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:apimanagement:ApiSchema ec12520d-9d48-4e7b-8f39-698ca2ac63f1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
* ```
*
*/
@ResourceType(type="azure-native:apimanagement:ApiSchema")
public class ApiSchema extends com.pulumi.resources.CustomResource {
/**
* Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
*
*/
@Export(name="components", refs={Object.class}, tree="[0]")
private Output components;
/**
* @return Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
*
*/
public Output> components() {
return Codegen.optional(this.components);
}
/**
* Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.
*
*/
@Export(name="contentType", refs={String.class}, tree="[0]")
private Output contentType;
/**
* @return Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.
*
*/
public Output contentType() {
return this.contentType;
}
/**
* Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
*
*/
@Export(name="definitions", refs={Object.class}, tree="[0]")
private Output definitions;
/**
* @return Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
*
*/
public Output> definitions() {
return Codegen.optional(this.definitions);
}
/**
* The name of the resource
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the resource
*
*/
public Output name() {
return this.name;
}
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public Output type() {
return this.type;
}
/**
* Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
*
*/
@Export(name="value", refs={String.class}, tree="[0]")
private Output value;
/**
* @return Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
*
*/
public Output> value() {
return Codegen.optional(this.value);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public ApiSchema(java.lang.String name) {
this(name, ApiSchemaArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ApiSchema(java.lang.String name, ApiSchemaArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public ApiSchema(java.lang.String name, ApiSchemaArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apimanagement:ApiSchema", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private ApiSchema(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apimanagement:ApiSchema", name, null, makeResourceOptions(options, id), false);
}
private static ApiSchemaArgs makeArgs(ApiSchemaArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ApiSchemaArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:apimanagement/v20170301:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20180101:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20180601preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20190101:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20191201:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20191201preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20200601preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20201201:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20210101preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20210401preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20210801:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20211201preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20220401preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20220801:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20220901preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20230301preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20230501preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20230901preview:ApiSchema").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20240501:ApiSchema").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static ApiSchema get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ApiSchema(name, id, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy