SearchServiceUpdate クラス
Azure Cognitive Search サービスの更新に使用されるパラメーター。
変数はサーバーによってのみ設定され、要求の送信時には無視されます。
- 継承
-
azure.mgmt.search.models._models_py3.ResourceSearchServiceUpdate
コンストラクター
SearchServiceUpdate(*, sku: _models.Sku | None = None, location: str | None = None, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str | _models.HostingMode = 'default', public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk: _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None, auth_options: _models.DataPlaneAuthOptions | None = None, **kwargs: Any)パラメーター
- sku
- Sku
価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。
- location
- str
リソースの地理的な場所。 これは、サポートおよび登録されている Azure Geo リージョンのいずれかである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。
- identity
- Identity
リソースの ID。
- replica_count
- int
検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、基本 SKU の場合は 1 から 3 までの値である必要があります。
- partition_count
- int
検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
- hosting_mode
- str または HostingMode
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可される最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。 既知の値は、"default" と "highDensity" です。
- public_network_access
- str または PublicNetworkAccess
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方法になります。 既知の値は、"enabled" と "disabled" です。
- network_rule_set
- NetworkRuleSet
Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有の規則。
- encryption_with_cmk
- EncryptionWithCmk
検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
- disable_local_auth
- bool
true に設定すると、検索サービスの呼び出しで認証に API キーを使用することは許可されません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。
- auth_options
- DataPlaneAuthOptions
検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
変数
- id
- str
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name
- str
リソースの名前。
- type
- str
リソースの型。 たとえば、"Microsoft.Compute/virtualMachines" や "Microsoft.Storage/storageAccounts" などです。
- sku
- Sku
価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。
- location
- str
リソースの地理的な場所。 これは、サポートおよび登録されている Azure Geo リージョンのいずれかである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。
- identity
- Identity
リソースの ID。
- replica_count
- int
検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、基本 SKU の場合は 1 から 3 までの値である必要があります。
- partition_count
- int
検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
- hosting_mode
- str または HostingMode
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可される最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。 既知の値は、"default" と "highDensity" です。
- public_network_access
- str または PublicNetworkAccess
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方法になります。 既知の値は、"enabled" と "disabled" です。
- status
- str または SearchServiceStatus
検索サービスの状態。 使用可能な値は次のとおりです。 'running' : 検索サービスが実行されており、プロビジョニング操作は進行中ありません。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効です。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラー状態にある場合は、Azure Cognitive Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。 既知の値は、"running"、"provisioning"、"removeing"、"degraded"、"disabled"、"error"、および "stopped" です。
- status_details
- str
検索サービスの状態の詳細。
- provisioning_state
- str または ProvisioningState
検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState は 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作が完了したことを確認することで、プロビジョニング状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。 既知の値は、"succeeded"、"provisioning"、"failed" です。
- network_rule_set
- NetworkRuleSet
Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有の規則。
- encryption_with_cmk
- EncryptionWithCmk
検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
- disable_local_auth
- bool
true に設定すると、検索サービスの呼び出しで認証に API キーを使用することは許可されません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。
- auth_options
- DataPlaneAuthOptions
検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
- private_endpoint_connections
- list[PrivateEndpointConnection]
Azure Cognitive Search サービスへのプライベート エンドポイント接続の一覧。
- shared_private_link_resources
- list[SharedPrivateLinkResource]
Azure Cognitive Search サービスによって管理される共有プライベート リンク リソースの一覧。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示