Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

getSchema

Schema Contract details. 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>
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]
func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput

> 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)
}
public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:apimanagement:getSchema
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group.

SchemaId string

Schema id identifier. Must be unique in the current API Management service instance.

ServiceName string

The name of the API Management service.

ResourceGroupName string

The name of the resource group.

SchemaId string

Schema id identifier. Must be unique in the current API Management service instance.

ServiceName string

The name of the API Management service.

resourceGroupName String

The name of the resource group.

schemaId String

Schema id identifier. Must be unique in the current API Management service instance.

serviceName String

The name of the API Management service.

resourceGroupName string

The name of the resource group.

schemaId string

Schema id identifier. Must be unique in the current API Management service instance.

serviceName string

The name of the API Management service.

resource_group_name str

The name of the resource group.

schema_id str

Schema id identifier. Must be unique in the current API Management service instance.

service_name str

The name of the API Management service.

resourceGroupName String

The name of the resource group.

schemaId String

Schema id identifier. Must be unique in the current API Management service instance.

serviceName String

The name of the API Management service.

getSchema Result

The following output properties are available:

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.

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.

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.

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.

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.

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
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0