次の方法で共有

Workspace Policy - Create Or Update

  • リファレンス
サービス:
API Management
API バージョン:
2024-05-01

ワークスペースのポリシー構成を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/policy?api-version=2024-05-01

URI パラメーター

名前 / 必須 型 説明
policyId
 path True

PolicyIdName

ポリシーの識別子。
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 である必要があります。
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

ワークスペース識別子。 現在の API Management サービス インスタンスで一意である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
If-Match

string

エンティティの ETag。 エンティティを作成する場合は必要ありませんが、エンティティを更新する場合は必須です。

要求本文

名前 必須 型 説明
properties.value True

string

形式で定義されているポリシーの内容。
properties.format

PolicyContentFormat

policyContent の形式。

応答

名前 型 説明
200 OK

PolicyContract

テナントのワークスペース ポリシー構成が正常に更新されました。

ヘッダー

ETag: string
201 Created

PolicyContract

ワークスペース ポリシーの構成が正常に作成されました。

ヘッダー

ETag: string
Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementCreateWorkspacePolicy
ApiManagementCreateWorkspacePolicyNonXmlEncoded

ApiManagementCreateWorkspacePolicy

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy?api-version=2024-05-01


{
  "properties": {
    "format": "xml",
    "value": "<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>"
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy",
  "type": "Microsoft.ApiManagement/service/workspaces/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>"
  }
}
状態コード:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy",
  "type": "Microsoft.ApiManagement/service/workspaces/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>"
  }
}

ApiManagementCreateWorkspacePolicyNonXmlEncoded

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy?api-version=2024-05-01


{
  "properties": {
    "value": "<policies>\r\n     <inbound>\r\n     <base />\r\n  <set-header name=\"newvalue\" exists-action=\"override\">\r\n   <value>\"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" </value>\r\n    </set-header>\r\n  </inbound>\r\n      </policies>",
    "format": "rawxml"
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy",
  "type": "Microsoft.ApiManagement/service/workspaces/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound>\r\n    <base />\r\n    <set-header name=\"newvalue\" exists-action=\"override\">\r\n      <value>\"@(context.Request.Headers.FirstOrDefault(h =&gt; h.Ke==\"Via\"))\" </value>\r\n    </set-header>\r\n  </inbound>\r\n</policies>"
  }
}
状態コード:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy",
  "type": "Microsoft.ApiManagement/service/workspaces/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound>\r\n    <base />\r\n    <set-header name=\"newvalue\" exists-action=\"override\">\r\n      <value>\"@(context.Request.Headers.FirstOrDefault(h =&gt; h.Ke==\"Via\"))\" </value>\r\n    </set-header>\r\n  </inbound>\r\n</policies>"
  }
}

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
PolicyContentFormat

policyContent の形式。
PolicyContract

ポリシー コントラクトの詳細。
PolicyIdName

ポリシーの識別子。

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

PolicyContentFormat

列挙

policyContent の形式。

値 説明
rawxml

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

ポリシー ドキュメントは XML エンコードされておらず、API Management サービスからアクセスできる HTTP エンドポイントでホストされています。
xml

コンテンツはインラインで、コンテンツ タイプは XML ドキュメントです。
xml-link

ポリシー XML ドキュメントは、API Management サービスからアクセスできる HTTP エンドポイントでホストされます。

PolicyContract

Object

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

名前 型 規定値 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.format

PolicyContentFormat

xml

policyContent の形式。
properties.value

string

形式で定義されているポリシーの内容。
type

string

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PolicyIdName

列挙

ポリシーの識別子。

値 説明
policy