1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getGlobalSchema
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.getGlobalSchema

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Gets the details of the Schema specified by its identifier. Azure REST API version: 2022-08-01.

    Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview.

    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)
    // Output-based functions aren't available in Java yet
    
    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:

    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.
    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.
    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.
    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.
    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.
    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 v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi