Services - Create Or Update

サービス:: Search Management

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

指定されたリソースグループ内の検索サービスを作成または更新します。検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	指定したリソースグループに関連付けられている Azure AI Search サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	この要求を識別するクライアントによって生成される GUID 値。指定した場合、これは要求を追跡する方法として応答情報に含まれます。

要求本文

名前	必須	型	説明
location	True	string	リソースが存在する地理的な場所
identity		Identity	リソースの ID。
properties.authOptions		DataPlaneAuthOptions	検索サービスのデータプレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
properties.computeType		ComputeType	既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。
properties.dataExfiltrationProtections		SearchDataExfiltrationProtection[]	検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。現在、サポートされる唯一の値は、将来計画されるより細かい制御を使用して、すべての可能なデータエクスポートシナリオを無効にする 'All' です。
properties.disableLocalAuth		boolean	true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。
properties.encryptionWithCmk		EncryptionWithCmk	検索サービス内でカスタマーマネージャーキーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
properties.endpoint		string (uri)	Azure AI Search サービスのエンドポイント。
properties.hostingMode		HostingMode	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'Default' または 'HighDensity' のいずれかです。他のすべてのSKUの場合、この値は「デフォルト」である必要があります。
properties.networkRuleSet		NetworkRuleSet	Azure AI Search サービスに到達する方法を決定するネットワーク固有のルール。
properties.partitionCount		integer (int32) minimum: 1 maximum: 12	検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
properties.publicNetworkAccess		PublicNetworkAccess	この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。「無効」に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続が排他アクセス方法になります。
properties.replicaCount		integer (int32) minimum: 1 maximum: 12	検索サービス内のレプリカの数。指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。
properties.semanticSearch		SearchSemanticSearch	セマンティック検索の可用性を制御するオプションを設定します。この構成は、特定の場所にある特定の Azure AI Search SKU に対してのみ可能です。
properties.upgradeAvailable		UpgradeAvailable	検索サービスにアップグレードが利用可能かどうかを示します。
sku		Sku	価格レベルと容量の制限を決定する検索サービスの SKU。このプロパティは、新しい検索サービスを作成するときに必要です。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	SearchService	リソース「SearchService」更新操作が成功しました
201 Created	SearchService	リソース「SearchService」作成操作が成功しましたヘッダー Location: string Retry-After: integer
Other Status Codes	CloudError	予期しないエラー応答。

名前

型

説明

200 OK

SearchService

リソース「SearchService」更新操作が成功しました

201 Created

SearchService

リソース「SearchService」作成操作が成功しました

ヘッダー

Location: string
Retry-After: integer

Other Status Codes

CloudError

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

SearchCreateOrUpdateService

SearchCreateOrUpdateServiceAuthOptions

SearchCreateOrUpdateServiceDisableLocalAuth

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchCreateOrUpdateServiceWithCmkEnforcement

SearchCreateOrUpdateServiceWithDataExfiltration

SearchCreateOrUpdateServiceWithIdentity

SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceAuthOptions

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "disableLocalAuth": true,
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": null,
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": true,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": null,
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": true,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "publicNetworkAccess": "Disabled",
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Disabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Disabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "replicaCount": 1
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "replicaCount": 1
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 1,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    },
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Enabled"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Enabled"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateServiceWithIdentity

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  },
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

SearchCreateOrUpdateWithSemanticSearch

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "location": "westus",
  "properties": {
    "computeType": "Default",
    "hostingMode": "Default",
    "partitionCount": 1,
    "replicaCount": 3,
    "semanticSearch": "free"
  },
  "sku": {
    "name": "standard"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "semanticSearch": "free",
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

状態コード:: 201

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "provisioning",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "semanticSearch": "free",
    "serviceUpgradedAt": null,
    "sharedPrivateLinkResources": [],
    "status": "provisioning",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

定義

名前	説明
AadAuthFailureMode	認証に失敗した要求に対して検索サービスのデータプレーン API が送信する応答について説明します。
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
ComputeType	既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。
createdByType	リソースを作成した ID の種類。
DataPlaneAadOrApiKeyAuthOption	認証には、API キーまたは Microsoft Entra ID テナントからのアクセストークンを使用できることを示します。
DataPlaneAuthOptions	検索サービスがデータプレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
EncryptionWithCmk	カスタマーマネージドキーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。
HostingMode	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'Default' または 'HighDensity' のいずれかです。他のすべてのSKUの場合、この値は「デフォルト」である必要があります。
Identity	検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。
IdentityType	リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、システムによって作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。
IpRule	Azure AI Search サービスの IP 制限規則。
NetworkRuleSet	Azure AI Search サービスに到達する方法を決定するネットワーク固有のルール。
PrivateEndpointConnection	Azure AI Search サービスへの既存のプライベートエンドポイント接続について説明します。
PrivateEndpointConnectionProperties	検索サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。
PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	プライベートエンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。
PrivateLinkServiceConnectionProvisioningState	プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。
PrivateLinkServiceConnectionStatus	プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
ProvisioningState	検索サービスで最後に実行されたプロビジョニング操作の状態。プロビジョニングは、サービス容量の確立中に発生する中間状態です。容量が設定されると、provisioningState が "Succeeded" または "Failed" に変わります。クライアントアプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。無料サービスを使用している場合、この値は検索サービスの作成呼び出しで直接 "Succeeded" として返される傾向があります。これは、無料サービスで既に設定されている容量が使用されるためです。
PublicNetworkAccess	この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。「無効」に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続が排他アクセス方法になります。
SearchBypass	"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの発生元として考えられます。
SearchDataExfiltrationProtection	サービス上で無効化された特定のデータ流出シナリオ。
SearchEncryptionComplianceStatus	CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。
SearchEncryptionWithCmk	カスタマーマネージドキーで暗号化されていないオブジェクトが検索サービスによって検出された場合に、検索サービスがコンプライアンスを適用する方法について説明します。
SearchSemanticSearch	セマンティック検索の可用性を制御するオプションを設定します。この構成は、特定の場所にある特定の Azure AI Search SKU に対してのみ可能です。
SearchService	Azure AI Search サービスとその現在の状態について説明します。
SearchServiceStatus	検索サービスの状態。可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。これは、基になる検索単位が正常でない場合に発生する可能性があります。検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプション内にあります。サービスが機能低下、無効化、またはエラーの状態にある場合は、Azure AI Search チームが基になる問題を積極的に調査していることを意味します。これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。
SharedPrivateLinkResource	Azure AI Search サービスによって管理される共有プライベートリンクリソースについて説明します。
SharedPrivateLinkResourceProperties	Azure AI Search サービスによって管理されている既存の共有プライベートリンクリソースのプロパティについて説明します。
SharedPrivateLinkResourceProvisioningState	共有プライベートリンクリソースのプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です。
SharedPrivateLinkResourceStatus	共有プライベートリンクリソースの状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
Sku	課金レートと容量の制限を決定する検索サービスの SKU を定義します。
SkuName	検索サービスの SKU。有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UpgradeAvailable	検索サービスにアップグレードが利用可能かどうかを示します。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

AadAuthFailureMode

列挙

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

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

CloudError

Object

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

名前	型	説明
error	CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
message	string	問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

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

名前	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラーコード。特定のエラーケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

ComputeType

列挙

既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。

値	説明
Default	既定のコンピューティングを使用してサービスを作成します。
Confidential	Azure Confidential Compute を使用してサービスを作成します。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DataPlaneAadOrApiKeyAuthOption

Object

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

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

DataPlaneAuthOptions

Object

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

名前	型	説明
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	認証には、API キーまたは Microsoft Entra ID テナントからのアクセストークンを使用できることを示します。
apiKeyOnly		認証に使用できるのは API キーだけであることを示します。

EncryptionWithCmk

Object

カスタマーマネージドキーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。

名前	型	説明
encryptionComplianceStatus	SearchEncryptionComplianceStatus	CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。
enforcement	SearchEncryptionWithCmk	カスタマーマネージドキーで暗号化されていないオブジェクトが検索サービスによって検出された場合に、検索サービスがコンプライアンスを適用する方法について説明します。

HostingMode

列挙

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

値	説明
Default	インデックス数の制限は、SKU の既定の制限によって決まります。
HighDensity	検索サービスに最大 1,000 個のインデックスを含めることができる Standard3 SKU のアプリケーションのみ。

Identity

Object

検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。

名前	型	説明
principalId	string	検索サービスのシステム割り当て ID のプリンシパル ID。
tenantId	string	検索サービスのシステム割り当て ID のテナント ID。
type	IdentityType	リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、システムによって作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities	<string, UserAssignedIdentity>	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。

IdentityType

列挙

リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、システムによって作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。

値	説明
None	検索サービスに関連付けられているすべての ID を削除する必要があることを示します。
SystemAssigned	検索サービスのシステム割り当て ID が有効になっていることを示します。
UserAssigned	1 つ以上のユーザー割り当て ID が検索サービスに割り当てられることを示します。
SystemAssigned, UserAssigned	検索サービスのシステム割り当て ID が、1 つ以上のユーザー割り当て ID の割り当てと共に有効になっていることを示します。

IpRule

Object

Azure AI Search サービスの IP 制限規則。

名前	型	説明
value	string	1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。

NetworkRuleSet

Object

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

名前	型	説明
bypass	SearchBypass	"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの発生元として考えられます。
ipRules	IpRule[]	検索サービスエンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP ルールを使用してもパブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他的アクセス方法になります。

PrivateEndpointConnection

Object

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

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	PrivateEndpointConnectionProperties	Azure AI Search サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

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

名前	型	説明
groupId	string	プライベートリンクサービスの対象となる Azure リソースのグループ ID。
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	プライベートエンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。
provisioningState	PrivateLinkServiceConnectionProvisioningState	プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。

PrivateEndpointConnectionPropertiesPrivateEndpoint

Object

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

名前	型	説明
id	string	Microsoft.Network プロバイダーからのプライベートエンドポイントリソースのリソース ID。

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Object

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

名前	型	規定値	説明
actionsRequired	string	None	必要になる可能性がある追加のアクションの説明。
description	string		プライベートリンクサービスの接続状態の説明。
status	PrivateLinkServiceConnectionStatus		プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

PrivateLinkServiceConnectionProvisioningState

列挙

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

値	説明
Updating	プライベートリンクサービス接続は、他のリソースと共に作成され、完全に機能するように処理中です。
Deleting	プライベートリンクサービス接続は削除中です。
Failed	プライベートリンクサービス接続をプロビジョニングまたは削除できませんでした。
Succeeded	プライベートリンクサービス接続のプロビジョニングが完了し、承認の準備が整いました。
Incomplete	プライベートリンクサービス接続リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。
Canceled	プライベートリンクサービス接続リソースのプロビジョニング要求が取り消されました。

PrivateLinkServiceConnectionStatus

列挙

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

値	説明
Pending	プライベートエンドポイント接続が作成され、承認が保留中です。
Approved	プライベートエンドポイント接続が承認され、使用できる状態になります。
Rejected	プライベートエンドポイント接続が拒否され、使用できません。
Disconnected	プライベートエンドポイント接続がサービスから削除されました。

ProvisioningState

列挙

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

値	説明
succeeded	最後のプロビジョニング操作が正常に完了しました。
provisioning	検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。
failed	最後のプロビジョニング操作が失敗しました。

PublicNetworkAccess

列挙

この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。「無効」に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続が排他アクセス方法になります。

値	説明
Enabled	検索サービスは、パブリックインターネットから送信されたトラフィックからアクセスできます。
Disabled	検索サービスは、パブリックインターネットから送信されたトラフィックからアクセスできません。アクセスは、承認されたプライベートエンドポイント接続経由でのみ許可されます。
SecuredByPerimeter	ネットワークセキュリティペリメーターの設定ルールは、リソースへのパブリックネットワークアクセスを許可または禁止します。関連するネットワークセキュリティ境界が必要です。

SearchBypass

列挙

"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの発生元として考えられます。

値	説明
None	"ipRules" セクションで定義されている規則を、配信元がバイパスできないことを示します。これが既定値です。
AzureServices	Azure 信頼済みサービスから送信された要求が、"ipRules" セクションで定義されている規則をバイパスできることを示します。

SearchDataExfiltrationProtection

列挙

サービス上で無効化された特定のデータ流出シナリオ。

値	説明
BlockAll	すべてのデータ流出シナリオが無効であることを示します。

SearchEncryptionComplianceStatus

列挙

CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。

値	説明
Compliant	CMK で暗号化されていないオブジェクトの数がゼロであるか、強制が無効になっているため、検索サービスが準拠していることを示します。
NonCompliant	検索サービスに、CMK で暗号化されていないオブジェクトが複数存在することを示します。

SearchEncryptionWithCmk

列挙

カスタマーマネージドキーで暗号化されていないオブジェクトが検索サービスによって検出された場合に、検索サービスがコンプライアンスを適用する方法について説明します。

値	説明
Disabled	カスタマーマネージドキー暗号化は適用されません。組み込みのサービスマネージド暗号化のみが使用されます。
Enabled	1 つ以上のオブジェクトがカスタマーマネージドキーで暗号化されていない場合、検索サービスは非準拠としてマークされます。
Unspecified	強制ポリシーは明示的に指定されていません。動作は、"無効" に設定されている場合と同じです。

SearchSemanticSearch

列挙

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

値	説明
disabled	検索サービスでセマンティックリランカーが無効になっていることを示します。これが既定値です。
free	検索サービスでセマンティックリランカーを有効にし、無料プランの制限内で使用されることを示します。無料プランはセマンティックランク付け要求の量を上限とし、追加料金なしで提供されます。これは、新しくプロビジョニングされた検索サービスの既定値です。
standard	より高いスループットとセマンティックに再ランク付けされたクエリのボリュームを使用して、課金対象の機能として検索サービスのセマンティックリランカーを有効にします。

SearchService

Object

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

名前	型	規定値	説明
id	string (arm-id)		リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		リソースの ID。
location	string		リソースが存在する地理的な場所
name	string		リソースの名前
properties.authOptions	DataPlaneAuthOptions		検索サービスのデータプレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
properties.computeType	ComputeType		既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。現在、サポートされる唯一の値は、将来計画されるより細かい制御を使用して、すべての可能なデータエクスポートシナリオを無効にする 'All' です。
properties.disableLocalAuth	boolean		true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。
properties.eTag	string		更新中にオプティミスティックコンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。
properties.encryptionWithCmk	EncryptionWithCmk		検索サービス内でカスタマーマネージャーキーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
properties.endpoint	string (uri)		Azure AI Search サービスのエンドポイント。
properties.hostingMode	HostingMode	Default	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'Default' または 'HighDensity' のいずれかです。他のすべてのSKUの場合、この値は「デフォルト」である必要があります。
properties.networkRuleSet	NetworkRuleSet		Azure AI Search サービスに到達する方法を決定するネットワーク固有のルール。
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
properties.privateEndpointConnections	PrivateEndpointConnection[]		Azure AI Search サービスへのプライベートエンドポイント接続の一覧。
properties.provisioningState	ProvisioningState		検索サービスで最後に実行されたプロビジョニング操作の状態。プロビジョニングは、サービス容量の確立中に発生する中間状態です。容量が設定されると、provisioningState が "Succeeded" または "Failed" に変わります。クライアントアプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。無料サービスを使用している場合、この値は検索サービスの作成呼び出しで直接 "Succeeded" として返される傾向があります。これは、無料サービスで既に設定されている容量が使用されるためです。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。「無効」に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続が排他アクセス方法になります。
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	検索サービス内のレプリカの数。指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。
properties.semanticSearch	SearchSemanticSearch		セマンティック検索の可用性を制御するオプションを設定します。この構成は、特定の場所にある特定の Azure AI Search SKU に対してのみ可能です。
properties.serviceUpgradedAt	string (date-time)		検索サービスが最後にアップグレードされた日時。このフィールドは、サービスが初めてアップグレードされるまで null になります。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Azure AI Search サービスによって管理される共有プライベートリンクリソースの一覧。
properties.status	SearchServiceStatus		検索サービスの状態。可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。これは、基になる検索単位が正常でない場合に発生する可能性があります。検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプション内にあります。サービスが機能低下、無効化、またはエラーの状態にある場合は、Azure AI Search チームが基になる問題を積極的に調査していることを意味します。これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。
properties.statusDetails	string		検索サービスの状態の詳細。
properties.upgradeAvailable	UpgradeAvailable		検索サービスにアップグレードが利用可能かどうかを示します。
sku	Sku		価格レベルと容量の制限を決定する検索サービスの SKU。このプロパティは、新しい検索サービスを作成するときに必要です。
systemData	systemData		createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object		リソースタグ。
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SearchServiceStatus

列挙

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

値	説明
running	検索サービスが実行されており、プロビジョニング操作は行われません。
provisioning	検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。
deleting	検索サービスが削除されています。
degraded	基になる検索ユニットが正常ではないため、検索サービスが低下します。
disabled	検索サービスは無効になっており、すべての API 要求が拒否されます。
error	検索サービスは、プロビジョニングに失敗したか削除されることを示すエラー状態です。
stopped	検索サービスは、無効になっているサブスクリプション内にあります。

SharedPrivateLinkResource

Object

Azure AI Search サービスによって管理される共有プライベートリンクリソースについて説明します。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	SharedPrivateLinkResourceProperties	Azure AI Search サービスによって管理される共有プライベートリンクリソースのプロパティについて説明します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Object

Azure AI Search サービスによって管理されている既存の共有プライベートリンクリソースのプロパティについて説明します。

名前	型	説明
groupId	string	共有プライベートリンクリソースの対象となるリソースのプロバイダーからのグループ ID。
privateLinkResourceId	string	共有プライベートリンクリソースの対象となるリソースのリソース ID。
provisioningState	SharedPrivateLinkResourceProvisioningState	共有プライベートリンクリソースのプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です。
requestMessage	string	共有プライベートリンクリソースの承認を要求するためのメッセージ。
resourceRegion	string	任意。共有プライベートリンクを作成するリソースの Azure Resource Manager の場所を指定するために使用できます。これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。
status	SharedPrivateLinkResourceStatus	共有プライベートリンクリソースの状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

SharedPrivateLinkResourceProvisioningState

列挙

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

値	説明
Updating	共有プライベートリンクリソースは、完全に機能するために、他のリソースと共に作成中です。
Deleting	共有プライベートリンクリソースは削除中です。
Failed	共有プライベートリンクリソースをプロビジョニングまたは削除できませんでした。
Succeeded	共有プライベートリンクリソースのプロビジョニングが完了し、承認の準備が整いました。
Incomplete	共有プライベートリンクリソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。

SharedPrivateLinkResourceStatus

列挙

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

値	説明
Pending	共有プライベートリンクリソースが作成され、承認が保留中です。
Approved	共有プライベートリンクリソースが承認され、使用できる状態になります。
Rejected	共有プライベートリンクリソースは拒否され、使用できません。
Disconnected	共有プライベートリンクリソースがサービスから削除されました。

Sku

Object

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

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

値	説明
free	無料レベル。SLA が保証されておらず、課金対象レベルで提供される機能のサブセットも含まれます。
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 個のパーティションをサポートする専用サービスの課金対象レベル。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UpgradeAvailable

列挙

検索サービスにアップグレードが利用可能かどうかを示します。

値	説明
notAvailable	現在、アップグレードはサービスで使用できません。
available	サービスに対して利用可能なアップグレードがあります。

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。

次の方法で共有

Services - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

SearchCreateOrUpdateService

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceAuthOptions

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceDisableLocalAuth

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceWithCmkEnforcement

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceWithDataExfiltration

要求のサンプル

応答のサンプル

SearchCreateOrUpdateServiceWithIdentity

要求のサンプル

応答のサンプル

SearchCreateOrUpdateWithSemanticSearch

要求のサンプル

応答のサンプル

定義

AadAuthFailureMode

CloudError

CloudErrorBody

ComputeType

createdByType

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

HostingMode

Identity

IdentityType

IpRule

NetworkRuleSet

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpointConnectionPropertiesPrivateEndpoint

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SearchBypass

SearchDataExfiltrationProtection

SearchEncryptionComplianceStatus

SearchEncryptionWithCmk

SearchSemanticSearch

SearchService

SearchServiceStatus

SharedPrivateLinkResource

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceProvisioningState

SharedPrivateLinkResourceStatus

Sku

SkuName

systemData

UpgradeAvailable

UserAssignedIdentity