Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getSchema
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getSchema

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the details of the Schema specified by its identifier.

Uses Azure REST API version 2021-04-01-preview.

Using getSchema

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSchema(args: GetSchemaArgs, opts?: InvokeOptions): Promise<GetSchemaResult>
function getSchemaOutput(args: GetSchemaOutputArgs, opts?: InvokeOptions): Output<GetSchemaResult>
Copy
def get_schema(resource_group_name: Optional[str] = None,
               schema_id: Optional[str] = None,
               service_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(resource_group_name: Optional[pulumi.Input[str]] = None,
               schema_id: Optional[pulumi.Input[str]] = None,
               service_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSchemaResult]
Copy
func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput
Copy

> Note: This function is named LookupSchema in the Go SDK.

public static class GetSchema 
{
    public static Task<GetSchemaResult> InvokeAsync(GetSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaResult> Invoke(GetSchemaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getSchema
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
SchemaId
This property is required.
Changes to this property will trigger replacement.
string
Schema id identifier. Must be unique in the current API Management service instance.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
SchemaId
This property is required.
Changes to this property will trigger replacement.
string
Schema id identifier. Must be unique in the current API Management service instance.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
schemaId
This property is required.
Changes to this property will trigger replacement.
String
Schema id identifier. Must be unique in the current API Management service instance.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
schemaId
This property is required.
Changes to this property will trigger replacement.
string
Schema id identifier. Must be unique in the current API Management service instance.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
schema_id
This property is required.
Changes to this property will trigger replacement.
str
Schema id identifier. Must be unique in the current API Management service instance.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
schemaId
This property is required.
Changes to this property will trigger replacement.
String
Schema id identifier. Must be unique in the current API Management service instance.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getSchema Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
SchemaType string
Schema Type. Immutable.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
Free-form schema entity description.
Value string
Json-encoded string for non json-based schema.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
SchemaType string
Schema Type. Immutable.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
Free-form schema entity description.
Value string
Json-encoded string for non json-based schema.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
schemaType String
Schema Type. Immutable.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
Free-form schema entity description.
value String
Json-encoded string for non json-based schema.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
schemaType string
Schema Type. Immutable.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string
Free-form schema entity description.
value string
Json-encoded string for non json-based schema.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
schema_type str
Schema Type. Immutable.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str
Free-form schema entity description.
value str
Json-encoded string for non json-based schema.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
schemaType String
Schema Type. Immutable.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
Free-form schema entity description.
value String
Json-encoded string for non json-based schema.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native