Azure Native v2 v2.82.0, Jan 10 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

azure-native-v2.apimanagement.getWorkspaceApiSchema

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

function getWorkspaceApiSchema(args: GetWorkspaceApiSchemaArgs, opts?: InvokeOptions): Promise<GetWorkspaceApiSchemaResult>
function getWorkspaceApiSchemaOutput(args: GetWorkspaceApiSchemaOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceApiSchemaResult>

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]

func LookupWorkspaceApiSchema(ctx *Context, args *LookupWorkspaceApiSchemaArgs, opts ...InvokeOption) (*LookupWorkspaceApiSchemaResult, error)
func LookupWorkspaceApiSchemaOutput(ctx *Context, args *LookupWorkspaceApiSchemaOutputArgs, opts ...InvokeOption) LookupWorkspaceApiSchemaResultOutput

> 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)
}

public static CompletableFuture<GetWorkspaceApiSchemaResult> getWorkspaceApiSchema(GetWorkspaceApiSchemaArgs args, InvokeOptions options)
public static Output<GetWorkspaceApiSchemaResult> getWorkspaceApiSchema(GetWorkspaceApiSchemaArgs args, InvokeOptions options)

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

The following arguments are supported:

ApiId 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 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.
WorkspaceId string: Workspace identifier. Must be unique in the current API Management service instance.

ApiId 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 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.
WorkspaceId string: Workspace identifier. Must be unique in the current API Management service instance.

apiId 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 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.
workspaceId String: Workspace identifier. Must be unique in the current API Management service instance.

apiId 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 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.
workspaceId string: Workspace identifier. Must be unique in the current API Management service instance.

api_id 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 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.
workspace_id str: Workspace identifier. Must be unique in the current API Management service instance.

apiId 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 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.
workspaceId String: Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceApiSchema Result

The following output properties are available:

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.

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.

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.

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.

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.

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-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.apimanagement.getWorkspaceApiSchema

On this page

On this page

Using getWorkspaceApiSchema

getWorkspaceApiSchema Result

Package Details

On this page

On this page