Azure Native v1.103.0, Jun 2 23
Azure Native v1.103.0, Jun 2 23
azure-native.apimanagement.getApiSchema
Explore with Pulumi AI
Get the schema configuration at the API level. API Version: 2020-12-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:
- Api
Id 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.
- Resource
Group stringName The name of the resource group.
- Schema
Id string Schema identifier within an API. Must be unique in the current API Management service instance.
- Service
Name string The name of the API Management service.
- Api
Id 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.
- Resource
Group stringName The name of the resource group.
- Schema
Id string Schema identifier within an API. Must be unique in the current API Management service instance.
- Service
Name string The name of the API Management service.
- api
Id 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.
- resource
Group StringName The name of the resource group.
- schema
Id String Schema identifier within an API. Must be unique in the current API Management service instance.
- service
Name String The name of the API Management service.
- api
Id 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.
- resource
Group stringName The name of the resource group.
- schema
Id string Schema identifier within an API. Must be unique in the current API Management service instance.
- service
Name 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_ strname The name of the resource group.
- schema_
id str Schema identifier within an API. Must be unique in the current API Management service instance.
- service_
name str The name of the API Management service.
- api
Id 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.
- resource
Group StringName The name of the resource group.
- schema
Id String Schema identifier within an API. Must be unique in the current API Management service instance.
- service
Name String The name of the API Management service.
getApiSchema Result
The following output properties are available:
- Content
Type 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 useapplication/vnd.ms-azure-apim.swagger.definitions+json
-WSDL
Schema useapplication/vnd.ms-azure-apim.xsd+xml
-OpenApi
Schema useapplication/vnd.oai.openapi.components+json
-WADL Schema
useapplication/vnd.ms-azure-apim.wadl.grammars+xml
.- Id string
Resource ID.
- Name string
Resource name.
- Type string
Resource type for API Management resource.
- Definitions object
Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.
- Value string
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
- Content
Type 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 useapplication/vnd.ms-azure-apim.swagger.definitions+json
-WSDL
Schema useapplication/vnd.ms-azure-apim.xsd+xml
-OpenApi
Schema useapplication/vnd.oai.openapi.components+json
-WADL Schema
useapplication/vnd.ms-azure-apim.wadl.grammars+xml
.- Id string
Resource ID.
- Name string
Resource name.
- Type string
Resource type for API Management resource.
- Definitions interface{}
Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.
- Value string
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
- content
Type 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 useapplication/vnd.ms-azure-apim.swagger.definitions+json
-WSDL
Schema useapplication/vnd.ms-azure-apim.xsd+xml
-OpenApi
Schema useapplication/vnd.oai.openapi.components+json
-WADL Schema
useapplication/vnd.ms-azure-apim.wadl.grammars+xml
.- id String
Resource ID.
- name String
Resource name.
- type String
Resource type for API Management resource.
- definitions Object
Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.
- value String
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
- content
Type 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 useapplication/vnd.ms-azure-apim.swagger.definitions+json
-WSDL
Schema useapplication/vnd.ms-azure-apim.xsd+xml
-OpenApi
Schema useapplication/vnd.oai.openapi.components+json
-WADL Schema
useapplication/vnd.ms-azure-apim.wadl.grammars+xml
.- id string
Resource ID.
- name string
Resource name.
- type string
Resource type for API Management resource.
- definitions any
Types definitions. Used for Swagger/OpenAPI 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 useapplication/vnd.ms-azure-apim.swagger.definitions+json
-WSDL
Schema useapplication/vnd.ms-azure-apim.xsd+xml
-OpenApi
Schema useapplication/vnd.oai.openapi.components+json
-WADL Schema
useapplication/vnd.ms-azure-apim.wadl.grammars+xml
.- id str
Resource ID.
- name str
Resource name.
- type str
Resource type for API Management resource.
- definitions Any
Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.
- value str
Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
- content
Type 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 useapplication/vnd.ms-azure-apim.swagger.definitions+json
-WSDL
Schema useapplication/vnd.ms-azure-apim.xsd+xml
-OpenApi
Schema useapplication/vnd.oai.openapi.components+json
-WADL Schema
useapplication/vnd.ms-azure-apim.wadl.grammars+xml
.- id String
Resource ID.
- name String
Resource name.
- type String
Resource type for API Management resource.
- definitions Any
Types definitions. Used for Swagger/OpenAPI 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