Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getGlobalSchema
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getGlobalSchema

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the details of the Schema specified by its identifier.

    Uses Azure REST API version 2022-09-01-preview.

    Other available API versions: 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

    Using getGlobalSchema

    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 getGlobalSchema(args: GetGlobalSchemaArgs, opts?: InvokeOptions): Promise<GetGlobalSchemaResult>
function getGlobalSchemaOutput(args: GetGlobalSchemaOutputArgs, opts?: InvokeOptions): Output<GetGlobalSchemaResult>
    def get_global_schema(resource_group_name: Optional[str] = None,
                      schema_id: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetGlobalSchemaResult
def get_global_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[GetGlobalSchemaResult]
    func LookupGlobalSchema(ctx *Context, args *LookupGlobalSchemaArgs, opts ...InvokeOption) (*LookupGlobalSchemaResult, error)
func LookupGlobalSchemaOutput(ctx *Context, args *LookupGlobalSchemaOutputArgs, opts ...InvokeOption) LookupGlobalSchemaResultOutput

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

    public static class GetGlobalSchema 
{
    public static Task<GetGlobalSchemaResult> InvokeAsync(GetGlobalSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalSchemaResult> Invoke(GetGlobalSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGlobalSchemaResult> getGlobalSchema(GetGlobalSchemaArgs args, InvokeOptions options)
public static Output<GetGlobalSchemaResult> getGlobalSchema(GetGlobalSchemaArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:apimanagement:getGlobalSchema
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    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. The name is case insensitive.
    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. The name is case insensitive.
    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. The name is case insensitive.
    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. The name is case insensitive.
    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. The name is case insensitive.
    schemaId String
    Schema id identifier. Must be unique in the current API Management service instance.
    serviceName String
    The name of the API Management service.

    getGlobalSchema 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 object
    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 interface{}
    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 Object
    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 any
    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 Any
    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 Any
    Json-encoded string for non json-based schema.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native