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

azure-native.apimanagement.getWorkspaceApiSchema

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the schema configuration at the API level.

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 getWorkspaceApiSchema

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 getWorkspaceApiSchema(args: GetWorkspaceApiSchemaArgs, opts?: InvokeOptions): Promise<GetWorkspaceApiSchemaResult>
function getWorkspaceApiSchemaOutput(args: GetWorkspaceApiSchemaOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceApiSchemaResult>
Copy
def get_workspace_api_schema(api_id: Optional[str] = None,
                             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) -> GetWorkspaceApiSchemaResult
def get_workspace_api_schema_output(api_id: Optional[pulumi.Input[str]] = None,
                             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[GetWorkspaceApiSchemaResult]
Copy
func LookupWorkspaceApiSchema(ctx *Context, args *LookupWorkspaceApiSchemaArgs, opts ...InvokeOption) (*LookupWorkspaceApiSchemaResult, error)
func LookupWorkspaceApiSchemaOutput(ctx *Context, args *LookupWorkspaceApiSchemaOutputArgs, opts ...InvokeOption) LookupWorkspaceApiSchemaResultOutput
Copy

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

public static class GetWorkspaceApiSchema 
{
    public static Task<GetWorkspaceApiSchemaResult> InvokeAsync(GetWorkspaceApiSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceApiSchemaResult> Invoke(GetWorkspaceApiSchemaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceApiSchemaResult> getWorkspaceApiSchema(GetWorkspaceApiSchemaArgs args, InvokeOptions options)
public static Output<GetWorkspaceApiSchemaResult> getWorkspaceApiSchema(GetWorkspaceApiSchemaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceApiSchema
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId
This property is required.
Changes to this property will trigger replacement.
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
ApiId
This property is required.
Changes to this property will trigger replacement.
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
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.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
api_id
This property is required.
Changes to this property will trigger replacement.
str
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
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.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
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.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceApiSchema Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ContentType string
Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
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
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Components object
Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
Definitions object
Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
Value string
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
AzureApiVersion string
The Azure API version of the resource.
ContentType string
Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
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
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Components interface{}
Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
Definitions interface{}
Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
Value string
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
azureApiVersion String
The Azure API version of the resource.
contentType String
Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
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
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
components Object
Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
definitions Object
Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
value String
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
azureApiVersion string
The Azure API version of the resource.
contentType string
Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
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
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
components any
Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
definitions any
Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
value string
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
azure_api_version str
The Azure API version of the resource.
content_type str
Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
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
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
components Any
Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
definitions Any
Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
value str
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
azureApiVersion String
The Azure API version of the resource.
contentType String
Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
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
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
components Any
Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
definitions Any
Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
value String
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native