Policy Fragment - List By Service

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

すべてのポリシーフラグメントを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments?api-version=2024-05-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments?api-version=2024-05-01&$filter={$filter}&$orderby={$orderby}&$top={$top}&$skip={$skip}

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	\|フィールド \|使用法 \|サポートされる演算子 \|サポートされている関数 \| \|-------------\|-------------\|-------------\|-------------\| \|name \|filter、orderBy \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|description \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|value \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \|
$orderby	query		string	クエリによる OData の順序オプション。
$skip	query		integer (int32) minimum: 0	スキップするレコードの数。
$top	query		integer (int32) minimum: 1	返されるレコードの数。

応答

名前	型	説明
200 OK	PolicyFragmentCollection	ポリシーフラグメントの配列が正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementListPolicyFragments

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
      "type": "Microsoft.ApiManagement/service/policyFragments",
      "name": "policyFragment1",
      "properties": {
        "format": "xml",
        "description": "A policy fragment example",
        "value": "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PolicyFragmentCollection	ポリシーフラグメントの取得操作の応答。
PolicyFragmentContentFormat	ポリシーフラグメントコンテンツの形式。
PolicyFragmentContract	ポリシーフラグメントコントラクトの詳細。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

PolicyFragmentCollection

Object

ポリシーフラグメントの取得操作の応答。

名前	型	説明
count	integer (int64)	合計レコード数。
nextLink	string	次のページリンク (ある場合)。
value	PolicyFragmentContract[]	ポリシーフラグメントコントラクト値。

PolicyFragmentContentFormat

列挙

ポリシーフラグメントコンテンツの形式。

値	説明
rawxml	コンテンツはインラインで、コンテンツタイプは XML エンコードされていないポリシードキュメントです。
xml	コンテンツはインラインで、コンテンツタイプは XML ドキュメントです。

PolicyFragmentContract

Object

ポリシーフラグメントコントラクトの詳細。

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		リソースの名前
properties.description	string minLength: 0 maxLength: 1000		ポリシーフラグメントの説明。
properties.format	PolicyFragmentContentFormat	xml	ポリシーフラグメントコンテンツの形式。
properties.provisioningState	string		プロビジョニングの状態
properties.value	string		ポリシーフラグメントの内容。
type	string		リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

次の方法で共有

Policy Fragment - List By Service

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementListPolicyFragments

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PolicyFragmentCollection

PolicyFragmentContentFormat

PolicyFragmentContract

その他のリソース