次の方法で共有


Services - Update

特定のリソース グループ内の既存の検索サービスを更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2023-11-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName
path True

string

更新する検索サービスの名前。

subscriptionId
path True

string

Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API、コマンド ライン ツール、またはポータルから取得できます。

api-version
query True

string

各要求に使用する API バージョン。

要求ヘッダー

名前 必須 説明
x-ms-client-request-id

string

uuid

クライアントが生成した、この要求を識別する GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。

要求本文

名前 説明
identity

Identity

リソースの ID。

location

string

リソースの地理的な場所。 これは、サポートされ、登録されている Azure geo リージョンの 1 つである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。

properties.authOptions

DataPlaneAuthOptions

検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

properties.disableLocalAuth

boolean

true に設定すると、検索サービスへの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。

properties.encryptionWithCmk

EncryptionWithCmk

検索サービス内のカスタマー マネージャー キーを使用したリソース (インデックスなど) の暗号化に関するポリシーを指定します。

properties.hostingMode

HostingMode

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。

properties.networkRuleSet

NetworkRuleSet

検索サービスに到達する方法を決定するネットワーク固有のルール。

properties.partitionCount

integer

検索サービス内のパーティションの数。指定した場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。

properties.publicNetworkAccess

PublicNetworkAccess

この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

properties.replicaCount

integer

検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。

properties.semanticSearch

SearchSemanticSearch

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。

sku

Sku

課金レートと容量の制限を決定する検索サービスの SKU。 このプロパティは、新しい検索サービスを作成するときに必要です。

tags

object

Azure portalでリソースを分類するのに役立つタグ。

応答

名前 説明
200 OK

SearchService

既存のサービス定義が正常に更新されました。 レプリカまたはパーティションの数を変更した場合、スケール操作は非同期的に行われます。 provisioningState プロパティを使用して、サービス定義を定期的に取得し、進行状況を監視できます。

Other Status Codes

CloudError

HTTP 400 (無効な要求): 指定されたサービス定義が無効であるか、変更できないプロパティを変更しようとしました。詳細については、応答のエラー コードとメッセージを参照してください。 HTTP 404 (見つかりません): サブスクリプションまたはリソース グループが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。

セキュリティ

azure_auth

OAuth2 承認フローをMicrosoft Entra IDします。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceAuthOptions

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

SearchUpdateServiceDisableLocalAuth

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disableLocalAuth": true
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "disableLocalAuth": true,
    "authOptions": null
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled"
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "basic"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    }
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceToRemoveIdentity

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "sku": {
    "name": "standard"
  },
  "identity": {
    "type": "None"
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {},
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "None"
  }
}

SearchUpdateServiceWithCmkEnforcement

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    }
  }
}

SearchUpdateServiceWithSemanticSearch

要求のサンプル

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "semanticSearch": "standard"
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "semanticSearch": "standard"
  }
}

定義

名前 説明
AadAuthFailureMode

認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。

ApiKeyOnly

認証に API キーのみを使用できることを示します。

CloudError

API エラーに関する情報が含まれています。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

DataPlaneAadOrApiKeyAuthOption

Microsoft Entra ID テナントの API キーまたはアクセス トークンを認証に使用できることを示します。

DataPlaneAuthOptions

検索サービスがデータ プレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

EncryptionWithCmk

検索サービス内のリソースを customer=managed keys で暗号化する方法を決定するポリシーについて説明します。

HostingMode

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。

Identity

リソースの ID。

IdentityType

ID の種類。

IpRule

検索サービスの IP 制限規則。

NetworkRuleSet

検索サービスに到達する方法を決定するネットワーク固有のルール。

PrivateEndpoint

Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。

PrivateEndpointConnection

検索サービスへの既存のプライベート エンドポイント接続について説明します。

PrivateEndpointConnectionProperties

検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。

PrivateLinkServiceConnectionProvisioningState

プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です

PrivateLinkServiceConnectionState

Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。

ProvisioningState

検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。

PublicNetworkAccess

この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

SearchEncryptionComplianceStatus

顧客以外の暗号化されたリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。 サービスに複数の顧客が暗号化されていないリソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。

SearchEncryptionWithCmk

検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。

SearchSemanticSearch

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。

SearchService

検索サービスとその現在の状態について説明します。

SearchServiceStatus

検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合、Microsoft は基になる問題を積極的に調査しています。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。

SearchServiceUpdate

検索サービスの更新に使用されるパラメーター。

SharedPrivateLinkResource

検索サービスによって管理される共有Private Link リソースについて説明します。

SharedPrivateLinkResourceProperties

検索サービスによって管理される既存の共有Private Link リソースのプロパティについて説明します。

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

Sku

課金レートと容量の制限を決定する検索サービスの SKU を定義します。

SkuName

検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、より多くのインデックスを持つ最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。

AadAuthFailureMode

認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。

名前 説明
http401WithBearerChallenge

string

認証に失敗した要求に HTTP 状態コード 401 (未承認) を提示し、ベアラー チャレンジを提示する必要があることを示します。

http403

string

認証に失敗した要求に HTTP 状態コード 403 (禁止) を提示する必要があることを示します。

ApiKeyOnly

認証に API キーのみを使用できることを示します。

CloudError

API エラーに関する情報が含まれています。

名前 説明
error

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

CloudErrorBody

エラー コードとメッセージを含む特定の API エラーについて説明します。

名前 説明
code

string

エラー状態を HTTP 状態コードよりも正確に記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。

details

CloudErrorBody[]

このエラーに関連する入れ子になったエラーが含まれています。

message

string

エラーの詳細を説明し、デバッグ情報を提供するメッセージ。

target

string

特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

DataPlaneAadOrApiKeyAuthOption

Microsoft Entra ID テナントの API キーまたはアクセス トークンを認証に使用できることを示します。

名前 説明
aadAuthFailureMode

AadAuthFailureMode

認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。

DataPlaneAuthOptions

検索サービスがデータ プレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

名前 説明
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Microsoft Entra ID テナントの API キーまたはアクセス トークンを認証に使用できることを示します。

apiKeyOnly

ApiKeyOnly

認証に API キーのみを使用できることを示します。

EncryptionWithCmk

検索サービス内のリソースを customer=managed keys で暗号化する方法を決定するポリシーについて説明します。

名前 説明
encryptionComplianceStatus

SearchEncryptionComplianceStatus

顧客以外の暗号化されたリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。 サービスに複数の顧客が暗号化されていないリソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。

enforcement

SearchEncryptionWithCmk

検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。

HostingMode

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。

名前 説明
default

string

インデックス数の制限は、SKU の既定の制限によって決まります。

highDensity

string

検索サービスに最大 1000 個のインデックスを含めることができる Standard3 SKU のアプリケーションのみ。

Identity

リソースの ID。

名前 説明
principalId

string

検索サービスのシステム割り当て ID のプリンシパル ID。

tenantId

string

検索サービスのシステム割り当て ID のテナント ID。

type

IdentityType

ID の種類。

IdentityType

ID の種類。

名前 説明
None

string

SystemAssigned

string

IpRule

検索サービスの IP 制限規則。

名前 説明
value

string

許可される 1 つの IPv4 アドレス (123.1.2.3 など) または CIDR 形式の IP 範囲 (123.1.2.3/24 など) に対応する値。

NetworkRuleSet

検索サービスに到達する方法を決定するネットワーク固有のルール。

名前 説明
ipRules

IpRule[]

IP ファイアウォールに使用される IP 制限規則の一覧。 規則に一致しない IP はすべて、ファイアウォールによってブロックされます。 これらのルールは、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。

PrivateEndpoint

Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。

名前 説明
id

string

Microsoft.Network プロバイダーからのプライベート エンドポイント リソースのリソース ID。

PrivateEndpointConnection

検索サービスへの既存のプライベート エンドポイント接続について説明します。

名前 説明
id

string

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

name

string

リソースの名前

properties

PrivateEndpointConnectionProperties

検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。

type

string

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

PrivateEndpointConnectionProperties

検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。

名前 説明
groupId

string

プライベート リンク サービス接続の対象となるリソースのプロバイダーからのグループ ID。

privateEndpoint

PrivateEndpoint

Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。

provisioningState

PrivateLinkServiceConnectionProvisioningState

プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です

PrivateLinkServiceConnectionProvisioningState

プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です

名前 説明
Canceled

string

プライベート リンク サービス接続リソースのプロビジョニング要求が取り消されました

Deleting

string

プライベート リンク サービス接続は削除中です。

Failed

string

プライベート リンク サービス接続のプロビジョニングまたは削除に失敗しました。

Incomplete

string

プライベート リンク サービス接続リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。

Succeeded

string

プライベート リンク サービス接続のプロビジョニングが完了し、承認の準備が整いました。

Updating

string

プライベート リンク サービス接続は、他のリソースと共に作成中であり、完全に機能します。

PrivateLinkServiceConnectionState

Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。

名前 規定値 説明
actionsRequired

string

None

必要になる可能性がある追加のアクションの説明。

description

string

プライベート リンク サービスの接続状態の説明。

status

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。

名前 説明
Approved

string

プライベート エンドポイント接続が承認され、使用できる状態になります。

Disconnected

string

プライベート エンドポイント接続がサービスから削除されました。

Pending

string

プライベート エンドポイント接続が作成され、承認が保留中です。

Rejected

string

プライベート エンドポイント接続が拒否され、使用できません。

ProvisioningState

検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。

名前 説明
failed

string

最後のプロビジョニング操作が失敗しました。

provisioning

string

検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。

succeeded

string

最後のプロビジョニング操作が正常に完了しました。

PublicNetworkAccess

この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

名前 説明
disabled

string

enabled

string

SearchEncryptionComplianceStatus

顧客以外の暗号化されたリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。 サービスに複数の顧客が暗号化されていないリソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。

名前 説明
Compliant

string

顧客が暗号化していないリソースの数が 0 であるか、強制が無効になっているため、検索サービスが準拠していることを示します。

NonCompliant

string

検索サービスに、顧客以外の暗号化されたリソースが複数存在することを示します。

SearchEncryptionWithCmk

検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。

名前 説明
Disabled

string

適用は行われず、検索サービスには顧客以外の暗号化されたリソースを含めることができます。

Enabled

string

Search Serviceは、顧客が暗号化していないリソースが 1 つ以上ある場合、非準拠としてマークされます。

Unspecified

string

強制ポリシーは明示的に指定されていません。動作は 、'Disabled' に設定されている場合と同じです。

SearchSemanticSearch

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。

名前 説明
disabled

string

検索サービスのセマンティック ランク付けが無効になっていることを示します。

free

string

検索サービスでセマンティック ランク付けが有効になり、Free レベルの制限内で使用されることを示します。 これにより、セマンティック ランク付け要求の量が上限になり、追加料金なしで提供されます。 これは、新しくプロビジョニングされた検索サービスの既定値です。

standard

string

より高いスループットと大量のセマンティック ランク付け要求を使用して、課金対象の機能として検索サービスでセマンティック ランク付けを有効にします。

SearchService

検索サービスとその現在の状態について説明します。

名前 規定値 説明
id

string

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

identity

Identity

リソースの ID。

location

string

リソースが保存されている地理的な場所

name

string

リソースの名前

properties.authOptions

DataPlaneAuthOptions

検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

properties.disableLocalAuth

boolean

true に設定すると、検索サービスへの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。

properties.encryptionWithCmk

EncryptionWithCmk

検索サービス内のカスタマー マネージャー キーを使用したリソース (インデックスなど) の暗号化に関するポリシーを指定します。

properties.hostingMode

HostingMode

default

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。

properties.networkRuleSet

NetworkRuleSet

検索サービスに到達する方法を決定するネットワーク固有のルール。

properties.partitionCount

integer

1

検索サービス内のパーティションの数。指定した場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。

properties.privateEndpointConnections

PrivateEndpointConnection[]

検索サービスへのプライベート エンドポイント接続の一覧。

properties.provisioningState

ProvisioningState

検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。

properties.publicNetworkAccess

PublicNetworkAccess

enabled

この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

properties.replicaCount

integer

1

検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。

properties.semanticSearch

SearchSemanticSearch

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

検索サービスによって管理される共有プライベート リンク リソースの一覧。

properties.status

SearchServiceStatus

検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合、Microsoft は基になる問題を積極的に調査しています。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。

properties.statusDetails

string

検索サービスの状態の詳細。

sku

Sku

課金レートと容量の制限を決定する検索サービスの SKU。 このプロパティは、新しい検索サービスを作成するときに必要です。

tags

object

リソース タグ。

type

string

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

SearchServiceStatus

検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合、Microsoft は基になる問題を積極的に調査しています。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。

名前 説明
degraded

string

基になる検索ユニットが正常でないため、検索サービスが低下しています。

deleting

string

検索サービスが削除されています。

disabled

string

検索サービスが無効になっており、すべての API 要求が拒否されます。

error

string

検索サービスがエラー状態であり、プロビジョニングの失敗または削除を示します。

provisioning

string

検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。

running

string

検索サービスが実行されており、プロビジョニング操作は進行中です。

SearchServiceUpdate

検索サービスの更新に使用されるパラメーター。

名前 規定値 説明
id

string

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

identity

Identity

リソースの ID。

location

string

リソースの地理的な場所。 これは、サポートされ、登録されている Azure geo リージョンの 1 つである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。

name

string

リソースの名前

properties.authOptions

DataPlaneAuthOptions

検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

properties.disableLocalAuth

boolean

true に設定すると、検索サービスへの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。

properties.encryptionWithCmk

EncryptionWithCmk

検索サービス内のカスタマー マネージャー キーを使用したリソース (インデックスなど) の暗号化に関するポリシーを指定します。

properties.hostingMode

HostingMode

default

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。

properties.networkRuleSet

NetworkRuleSet

検索サービスに到達する方法を決定するネットワーク固有のルール。

properties.partitionCount

integer

1

検索サービス内のパーティションの数。指定した場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。

properties.privateEndpointConnections

PrivateEndpointConnection[]

検索サービスへのプライベート エンドポイント接続の一覧。

properties.provisioningState

ProvisioningState

検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。

properties.publicNetworkAccess

PublicNetworkAccess

enabled

この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

properties.replicaCount

integer

1

検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。

properties.semanticSearch

SearchSemanticSearch

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

検索サービスによって管理される共有プライベート リンク リソースの一覧。

properties.status

SearchServiceStatus

検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合、Microsoft は基になる問題を積極的に調査しています。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。

properties.statusDetails

string

検索サービスの状態の詳細。

sku

Sku

課金レートと容量の制限を決定する検索サービスの SKU。 このプロパティは、新しい検索サービスを作成するときに必要です。

tags

object

Azure portalでリソースを分類するのに役立つタグ。

type

string

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

SharedPrivateLinkResource

検索サービスによって管理される共有Private Link リソースについて説明します。

名前 説明
id

string

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

name

string

リソースの名前

properties

SharedPrivateLinkResourceProperties

検索サービスによって管理される共有Private Link リソースのプロパティについて説明します。

type

string

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

SharedPrivateLinkResourceProperties

検索サービスによって管理される既存の共有Private Link リソースのプロパティについて説明します。

名前 説明
groupId

string

共有プライベート リンク リソースの対象となるリソースのプロバイダーからのグループ ID。

privateLinkResourceId

string

共有プライベート リンク リソースの対象となるリソースのリソース ID。

provisioningState

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

requestMessage

string

共有プライベート リンク リソースの承認を要求するための要求メッセージ。

resourceRegion

string

省略可能。 共有プライベート リンクを作成するリソースの Azure Resource Managerの場所を指定するために使用できます。 これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。

status

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。

名前 説明
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

名前 説明
Approved

string

Disconnected

string

Pending

string

Rejected

string

Sku

課金レートと容量の制限を決定する検索サービスの SKU を定義します。

名前 説明
name

SkuName

検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、より多くのインデックスを持つ最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。

SkuName

検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、より多くのインデックスを持つ最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。

名前 説明
basic

string

最大 3 つのレプリカを持つ専用サービスの課金対象レベル。

free

string

無料レベル。SLA が保証されておらず、課金対象レベルで提供される機能のサブセットが含まれます。

standard

string

最大 12 個のパーティションと 12 個のレプリカを持つ専用サービスの課金対象レベル。

standard2

string

'standard' に似ていますが、検索ユニットあたりの容量が多くなります。

standard3

string

最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが追加された最大 3 つのパーティション)。

storage_optimized_l1

string

パーティションあたり 1 TB、最大 12 個のパーティションをサポートする専用サービスの課金対象レベル。

storage_optimized_l2

string

パーティションあたり 2 TB、最大 12 個のパーティションをサポートする専用サービスの課金対象レベル。