azure-native.apimanagement.getWorkspaceGlobalSchema
Explore with Pulumi AI
Gets the details of the Schema specified by its identifier.
Uses Azure REST API version 2022-09-01-preview.
Other available API versions: 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 getWorkspaceGlobalSchema
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 getWorkspaceGlobalSchema(args: GetWorkspaceGlobalSchemaArgs, opts?: InvokeOptions): Promise<GetWorkspaceGlobalSchemaResult>
function getWorkspaceGlobalSchemaOutput(args: GetWorkspaceGlobalSchemaOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceGlobalSchemaResult>def get_workspace_global_schema(resource_group_name: Optional[str] = None,
                                schema_id: Optional[str] = None,
                                service_name: Optional[str] = None,
                                workspace_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetWorkspaceGlobalSchemaResult
def get_workspace_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,
                                workspace_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceGlobalSchemaResult]func LookupWorkspaceGlobalSchema(ctx *Context, args *LookupWorkspaceGlobalSchemaArgs, opts ...InvokeOption) (*LookupWorkspaceGlobalSchemaResult, error)
func LookupWorkspaceGlobalSchemaOutput(ctx *Context, args *LookupWorkspaceGlobalSchemaOutputArgs, opts ...InvokeOption) LookupWorkspaceGlobalSchemaResultOutput> Note: This function is named LookupWorkspaceGlobalSchema in the Go SDK.
public static class GetWorkspaceGlobalSchema 
{
    public static Task<GetWorkspaceGlobalSchemaResult> InvokeAsync(GetWorkspaceGlobalSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceGlobalSchemaResult> Invoke(GetWorkspaceGlobalSchemaInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetWorkspaceGlobalSchemaResult> getWorkspaceGlobalSchema(GetWorkspaceGlobalSchemaArgs args, InvokeOptions options)
public static Output<GetWorkspaceGlobalSchemaResult> getWorkspaceGlobalSchema(GetWorkspaceGlobalSchemaArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceGlobalSchema
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Schema
Id string - Schema id identifier. Must be unique in the current API Management service instance.
 - Service
Name string - The name of the API Management service.
 - Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
 
- Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Schema
Id string - Schema id identifier. Must be unique in the current API Management service instance.
 - Service
Name string - The name of the API Management service.
 - Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
 
- resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - schema
Id String - Schema id identifier. Must be unique in the current API Management service instance.
 - service
Name String - The name of the API Management service.
 - workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
 
- resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - schema
Id string - Schema id identifier. Must be unique in the current API Management service instance.
 - service
Name string - The name of the API Management service.
 - workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
 
- resource_
group_ strname  - 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.
 - workspace_
id str - Workspace identifier. Must be unique in the current API Management service instance.
 
- resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - schema
Id String - Schema id identifier. Must be unique in the current API Management service instance.
 - service
Name String - The name of the API Management service.
 - workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
 
getWorkspaceGlobalSchema Result
The following output properties are available:
- Azure
Api stringVersion  - 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
 - Schema
Type 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.
 
- Azure
Api stringVersion  - 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
 - Schema
Type 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.
 
- azure
Api StringVersion  - 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
 - schema
Type 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.
 
- azure
Api stringVersion  - 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
 - schema
Type 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_ strversion  - 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.
 
- azure
Api StringVersion  - 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
 - schema
Type 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