Api Operation Policy - Create Or Update
API 操作レベルのポリシー構成を作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/policy?api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在以外のリビジョンには があります。rev=n はサフィックスで、n はリビジョン番号です。 Regex pattern: |
operation
|
path | True |
string |
API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 |
policy
|
path | True |
ポリシーの識別子。 |
|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
If-Match |
string |
エンティティの ETag。 エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.value | True |
string |
形式で定義されたポリシーの内容。 |
properties.format |
policyContent の形式。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
テナントの API 操作ポリシー構成が正常に更新されました。 Headers ETag: string |
|
201 Created |
API 操作ポリシーの構成が正常に作成されました。 Headers ETag: string |
|
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 | ユーザー アカウントの借用 |
例
ApiManagementCreateApiOperationPolicy
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy?api-version=2022-08-01
{
"properties": {
"format": "xml",
"value": "<policies> <inbound /> <backend> <forward-request /> </backend> <outbound /></policies>"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy",
"type": "Microsoft.ApiManagement/service/apis/operations/policies",
"name": "policy",
"properties": {
"value": "<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy",
"type": "Microsoft.ApiManagement/service/apis/operations/policies",
"name": "policy",
"properties": {
"value": "<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"
}
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Policy |
policyContent の形式。 |
Policy |
ポリシー コントラクトの詳細。 |
Policy |
ポリシーの識別子。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
PolicyContentFormat
policyContent の形式。
名前 | 型 | 説明 |
---|---|---|
rawxml |
string |
コンテンツはインラインであり、コンテンツ タイプは XML エンコードされていないポリシー ドキュメントです。 |
rawxml-link |
string |
ポリシー ドキュメントは XML エンコードされておらず、API Management サービスからアクセスできる HTTP エンドポイントでホストされます。 |
xml |
string |
コンテンツはインラインで、コンテンツ タイプは XML ドキュメントです。 |
xml-link |
string |
ポリシー XML ドキュメントは、API Management サービスからアクセスできる HTTP エンドポイントでホストされます。 |
PolicyContract
ポリシー コントラクトの詳細。
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
name |
string |
リソースの名前 |
|
properties.format | xml |
policyContent の形式。 |
|
properties.value |
string |
形式で定義されたポリシーの内容。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
PolicyIdName
ポリシーの識別子。
名前 | 型 | 説明 |
---|---|---|
policy |
string |