Delen via

Get-AzApiManagementApiSchema

  • Referentie
Module:
Az.ApiManagement

De details van het API-schema ophalen

Syntaxis

Get-AzApiManagementApiSchema
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-SchemaId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementApiSchema
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

De cmdlet Get-AzApiManagementApiSchema haalt de details van het API-schema op

Voorbeelden

Voorbeeld 1: de details van het API-schema van een API ophalen

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163
Get-AzApiManagementApiSchema -Context $context -ApiId wsdlapitest

SchemaId           : 2a03e1b4-1826-4e59-b372-4711f575db28
Api Id             : wsdlapitest
Schema ContentType : xsdschema
Schema Document    : <s:schema elementFormDefault="qualified"....

SchemaId           : b6e5497d-f65a-4851-9f5b-b5684cdae688
Api Id             : wsdlapitest
Schema ContentType : xsdschema
Schema Document    : <?xml version=""1.0"" encoding=""UTF-8""....

Met deze opdracht worden alle API-schema's opgehaald die zijn gekoppeld aan een API swagger-petstore-extensive voor bepaalde ApiManagement-context.

Voorbeeld 2: het specifieke schema ophalen dat is gekoppeld aan een API

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163
Get-AzApiManagementApiSchema -Context $context -ApiId swagger-petstore-extensive -SchemaId 5cc9cf67e6ed3b1154e638bd

SchemaId           : 5cc9cf67e6ed3b1154e638bd
Api Id             : swagger-petstore-extensive
Schema ContentType : swaggerdefinition
Schema Document    : {
                       "definitions": {
                         "pet": {
                        ....

Met deze opdracht wordt het API-schema 5cc9cf67e6ed3b1154e638bd opgehaald dat is gekoppeld aan een API swagger-petstore-extensive voor bepaalde ApiManagement-context.

Parameters

-ApiId

API-id die moet worden gezocht. Als dit is opgegeven, wordt geprobeerd de API op basis van de id op te halen.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Context

Exemplaar van PsApiManagementContext. Deze parameter is vereist.

Type:PsApiManagementContext
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ResourceId

Arm-resource-id van een API-schema. Als dit is opgegeven, wordt geprobeerd om api-schema te vinden op basis van de id. Deze parameter is vereist.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SchemaId

De id van het schema.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

PsApiManagementContext

String

Uitvoerwaarden

PsApiManagementApiSchema