Api Schema - List By Api
API レベルでスキーマ構成を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在以外のリビジョンには があります。rev=n はサフィックスで、n はリビジョン番号です。 Regex pattern: |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
$filter
|
query |
string |
|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |
|
$skip
|
query |
integer int32 |
スキップするレコードの数。 |
|
$top
|
query |
integer int32 |
返されるレコードの数。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Apis スキーマ コレクション。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementListApiSchemas
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e",
"type": "Microsoft.ApiManagement/service/apis/schemas",
"name": "59d5b28e1f7fab116402044e",
"properties": {
"contentType": "application/vnd.ms-azure-apim.xsd+xml",
"document": {
"value": "<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n <s:element name=\"GetWeatherInformation\">\r\n <s:complexType />\r\n </s:element>\r\n <s:element name=\"GetWeatherInformationResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ArrayOfWeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"WeatherDescription\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityForecastByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityForecastByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"ForecastReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"ArrayOfForecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"Forecast\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"temp\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:complexType name=\"POP\">\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"GetCityWeatherByZIP\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:element name=\"GetCityWeatherByZIPResponse\">\r\n <s:complexType>\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n </s:sequence>\r\n </s:complexType>\r\n </s:element>\r\n <s:complexType name=\"WeatherReturn\">\r\n <s:sequence>\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n </s:sequence>\r\n </s:complexType>\r\n <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"
}
}
}
],
"count": 1,
"nextLink": ""
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Schema |
リスト スキーマ操作の応答。 |
Schema |
API スキーマ コントラクトの詳細。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
SchemaCollection
リスト スキーマ操作の応答。
名前 | 型 | 説明 |
---|---|---|
count |
integer |
レコード数の合計。 |
nextLink |
string |
次のページ リンク (存在する場合)。 |
value |
API スキーマ コントラクトの値。 |
SchemaContract
API スキーマ コントラクトの詳細。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties.contentType |
string |
RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディアの種類である必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 |
properties.document.components |
object |
型の定義。 Swagger/OpenAPI v2/v3 スキーマにのみ使用され、それ以外の場合は null。 |
properties.document.definitions |
object |
型の定義。 Swagger/OpenAPI v1 スキーマにのみ使用され、それ以外の場合は null。 |
properties.document.value |
string |
スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |