1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getApiSchema
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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

azure-native.apimanagement.getApiSchema

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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

    Get the schema configuration at the API level. Azure REST API version: 2022-08-01.

    Using getApiSchema

    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 getApiSchema(args: GetApiSchemaArgs, opts?: InvokeOptions): Promise<GetApiSchemaResult>
    function getApiSchemaOutput(args: GetApiSchemaOutputArgs, opts?: InvokeOptions): Output<GetApiSchemaResult>
    def get_api_schema(api_id: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       schema_id: Optional[str] = None,
                       service_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetApiSchemaResult
    def get_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,
                       opts: Optional[InvokeOptions] = None) -> Output[GetApiSchemaResult]
    func LookupApiSchema(ctx *Context, args *LookupApiSchemaArgs, opts ...InvokeOption) (*LookupApiSchemaResult, error)
    func LookupApiSchemaOutput(ctx *Context, args *LookupApiSchemaOutputArgs, opts ...InvokeOption) LookupApiSchemaResultOutput

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

    public static class GetApiSchema 
    {
        public static Task<GetApiSchemaResult> InvokeAsync(GetApiSchemaArgs args, InvokeOptions? opts = null)
        public static Output<GetApiSchemaResult> Invoke(GetApiSchemaInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiSchemaResult> getApiSchema(GetApiSchemaArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:apimanagement:getApiSchema
      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.

    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.

    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.

    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.

    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.

    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.

    getApiSchema 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 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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi