Services - Create Or Update

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

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

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

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

searchServiceName
path True
  • string

作成または更新するAzure Cognitive Search サービスの名前。 Search Service名には小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続するダッシュを含めることはできません。また、長さは 2 ~ 60 文字にする必要があります。 Search Service名は、サービス URI の一部であるため、グローバルに一意である必要があります (https://.search.windows.net). サービスの作成後にサービス名を変更することはできません。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

api-version
query True
  • string

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

要求ヘッダー

Name Required Type Description
x-ms-client-request-id
  • string
uuid

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

要求本文

Name Required Type Description
location True
  • string

リソースが存在する地理的な場所

identity

リソースの ID。

properties.authOptions

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

properties.disableLocalAuth
  • boolean

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

properties.disabledDataExfiltrationOptions
  • string[]

検索サービスで明示的に許可されていないデータ流出シナリオの一覧。 現時点でサポートされている値は、将来計画されるよりきめ細かなコントロールを使用して、すべての可能なデータ エクスポート シナリオを無効にする 'All' のみです。

properties.encryptionWithCmk

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

properties.hostingMode

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

properties.networkRuleSet

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

properties.partitionCount
  • integer

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

properties.publicNetworkAccess

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

properties.replicaCount
  • integer

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

properties.semanticSearch

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

sku

価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。

tags
  • object

リソース タグ。

応答

Name Type Description
200 OK

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

201 Created

無料検索サービスの作成を要求した場合、サービスはプロビジョニングされ、DNS 伝達の遅延が発生する可能性があります。 その他の SKU の種類の場合、プロビジョニングは非同期的に行われます。 provisioningState プロパティを使用して、サービス定義を定期的に取得し、進行状況を監視できます。

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithDataExfiltration
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default"
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceAuthOptions

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disableLocalAuth": true
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled",
    "hostingMode": "default"
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "hostingMode": "default"
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "hostingMode": "default"
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

SearchCreateOrUpdateServiceWithIdentity

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default"
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "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"
      }
    }
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "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"
      }
    }
  }
}

SearchCreateOrUpdateWithSemanticSearch

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2021-04-01-preview
{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "semanticSearch": "free"
  }
}

Sample Response

{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}
{
  "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"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}

定義

AadAuthFailureMode

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

ApiKeyOnly

認証に API キーのみを使用する必要があることを示します。

CloudError

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

CloudErrorBody

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

DataPlaneAadOrApiKeyAuthOption

認証に API キーまたは Azure Active Directory からのアクセス トークンを使用できることを示します。

DataPlaneAuthOptions

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

EncryptionWithCmk

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

HostingMode

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

Identity

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

IdentityType

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

IpRule

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

NetworkRuleSet

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

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 保留中、承認済み、拒否済み、または切断済みにすることができます。

ProvisioningState

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

PublicNetworkAccess

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

SearchBypass

"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの可能性のある配信元。

SearchEncryptionComplianceStatus

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

SearchEncryptionWithCmk

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

SearchSemanticSearch

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

SearchService

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

SearchServiceStatus

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

SharedPrivateLinkResource

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

SharedPrivateLinkResourceProperties

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

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 更新、削除、失敗、成功、不完全、またはその他の文書化されていない値を指定できます。

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 保留中、承認済み、拒否済み、切断済み、またはその他の値を文書化することはできません。

Sku

価格レベルと容量の制限を決定する、Azure Cognitive Search サービスの 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 個のパーティションをサポートします。

UserAssignedManagedIdentity

検索サービスに割り当てられたユーザー割り当てマネージド ID の詳細。

AadAuthFailureMode

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

Name Type Description
http401WithBearerChallenge
  • string

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

http403
  • string

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

ApiKeyOnly

認証に API キーのみを使用する必要があることを示します。

CloudError

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

Name Type Description
error

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

message
  • string

問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

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

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

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

DataPlaneAadOrApiKeyAuthOption

認証に API キーまたは Azure Active Directory からのアクセス トークンを使用できることを示します。

Name Type Description
aadAuthFailureMode

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

DataPlaneAuthOptions

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

Name Type Description
aadOrApiKey

認証に API キーまたは Azure Active Directory からのアクセス トークンを使用できることを示します。

apiKeyOnly

認証に API キーのみを使用する必要があることを示します。

EncryptionWithCmk

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

Name Type Description
encryptionComplianceStatus

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

enforcement

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

HostingMode

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

Name Type Description
default
  • string

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

highDensity
  • string

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

Identity

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

Name Type Description
principalId
  • string

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

tenantId
  • string

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

type

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

userAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

IdentityType

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

Name Type Description
None
  • string

検索サービスに関連付けられている ID を削除する必要があることを示します。

SystemAssigned
  • string

検索サービスのシステム割り当て ID が有効になっていることを示します。

SystemAssigned, UserAssigned
  • string

検索サービスのシステム割り当て ID が、1 つ以上のユーザー割り当て ID の割り当てと共に有効になっていることを示します。

UserAssigned
  • string

1 つ以上のユーザー割り当て ID が検索サービスに割り当てられることを示します。

IpRule

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

Name Type Description
value
  • string

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

NetworkRuleSet

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

Name Type Description
bypass

"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの可能性のある配信元。

ipRules

検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 その間、他のすべてのパブリック IP ネットワークはファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP ルールを使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

PrivateEndpoint

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

Name Type Description
id
  • string

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

PrivateEndpointConnection

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

Name Type Description
id
  • string

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

name
  • string

リソースの名前

properties

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

type
  • string

リソースの型。 "Microsoft.Compute/virtualMachines" や "Microsoft" など。Storage/storageAccounts"

PrivateEndpointConnectionProperties

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

Name Type Description
privateEndpoint

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

privateLinkServiceConnectionState

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

PrivateLinkServiceConnectionState

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

Name Type Default Value Description
actionsRequired
  • string
None

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

description
  • string

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

status

プライベート リンク サービス接続の状態。 保留中、承認済み、拒否済み、または切断済みにすることができます。

PrivateLinkServiceConnectionStatus

プライベート リンク サービス接続の状態。 保留中、承認済み、拒否済み、または切断済みにすることができます。

Name Type Description
Approved
  • string

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

Disconnected
  • string

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

Pending
  • string

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

Rejected
  • string

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

ProvisioningState

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

Name Type Description
failed
  • string

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

provisioning
  • string

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

succeeded
  • string

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

PublicNetworkAccess

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

Name Type Description
disabled
  • string

検索サービスは、パブリック インターネットからのトラフィックからアクセスできません。 アクセスは、承認されたプライベート エンドポイント接続経由でのみ許可されます。

enabled
  • string

検索サービスには、パブリック インターネットからのトラフィックからアクセスできます。

SearchBypass

"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの可能性のある配信元。

Name Type Description
AzurePortal
  • string

Azure portalから送信された要求が、"ipRules" セクションで定義されている規則をバイパスできることを示します。

None
  • string

"ipRules" セクションで定義されている規則を配信元がバイパスできないことを示します。 既定値です。

SearchEncryptionComplianceStatus

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

Name Type Description
Compliant
  • string

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

NonCompliant
  • string

検索サービスに 1 つ以上の非顧客暗号化リソースがあることを示します。

SearchEncryptionWithCmk

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

Name Type Description
Disabled
  • string

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

Enabled
  • string

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

Unspecified
  • string

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

SearchSemanticSearch

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

Name Type Description
disabled
  • string

検索サービスでセマンティック検索が無効になっていることを示します。 既定値です。

free
  • string

検索サービスでセマンティック検索を有効にし、Free レベルの制限内で使用されることを示します。 これにより、セマンティック検索要求の量が上限になり、追加料金なしで提供されます。

standard
  • string

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

SearchService

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

Name Type Default Value Description
id
  • string

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

identity

リソースの ID。

location
  • string

リソースが存在する地理的な場所

name
  • string

リソースの名前

properties.authOptions

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

properties.disableLocalAuth
  • boolean

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

properties.disabledDataExfiltrationOptions
  • string[]

検索サービスで明示的に許可されていないデータ流出シナリオの一覧。 現時点でサポートされている値は、将来計画されるよりきめ細かなコントロールを使用して、すべての可能なデータ エクスポート シナリオを無効にする 'All' のみです。

properties.eTag
  • string

更新中にオプティミスティック コンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。

properties.encryptionWithCmk

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

properties.hostingMode default

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

properties.networkRuleSet

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

properties.partitionCount
  • integer
1

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

properties.privateEndpointConnections

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

properties.provisioningState

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

properties.publicNetworkAccess enabled

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

properties.replicaCount
  • integer
1

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

properties.semanticSearch

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

properties.sharedPrivateLinkResources

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

properties.status

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

properties.statusDetails
  • string

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

sku

価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。

tags
  • object

リソース タグ。

type
  • string

リソースの型。 "Microsoft.Compute/virtualMachines" や "Microsoft" など。Storage/storageAccounts"

SearchServiceStatus

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

Name Type Description
degraded
  • string

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

deleting
  • string

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

disabled
  • string

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

error
  • string

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

provisioning
  • string

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

running
  • string

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

stopped
  • string

検索サービスは、無効になっているサブスクリプション内にあります。

SharedPrivateLinkResource

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

Name Type Description
id
  • string

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

name
  • string

リソースの名前

properties

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

type
  • string

リソースの型。 "Microsoft.Compute/virtualMachines" や "Microsoft" など。Storage/storageAccounts"

SharedPrivateLinkResourceProperties

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

Name Type Description
groupId
  • string

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

privateLinkResourceId
  • string

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

provisioningState

共有プライベート リンク リソースのプロビジョニング状態。 更新、削除、失敗、成功、不完全、またはその他の文書化されていない値を指定できます。

requestMessage
  • string

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

resourceRegion
  • string

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

status

共有プライベート リンク リソースの状態。 保留中、承認済み、拒否済み、切断済み、またはその他の値を文書化することはできません。

SharedPrivateLinkResourceProvisioningState

共有プライベート リンク リソースのプロビジョニング状態。 更新、削除、失敗、成功、不完全、またはその他の文書化されていない値を指定できます。

Name Type Description
Deleting
  • string

共有プライベート リンク リソースは、削除中です。

Failed
  • string

共有プライベート リンク リソースをプロビジョニングまたは削除できませんでした。

Incomplete
  • string

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

Succeeded
  • string

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

Updating
  • string

共有プライベート リンク リソースは、完全に機能するために、他のリソースと共に作成中です。

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態。 保留中、承認済み、拒否済み、切断済み、またはその他の値を文書化することはできません。

Name Type Description
Approved
  • string

共有プライベート リンク リソースが承認され、使用できる状態になります。

Disconnected
  • string

共有プライベート リンク リソースがサービスから削除されました。

Pending
  • string

共有プライベート リンク リソースが作成され、承認が保留中です。

Rejected
  • string

共有プライベート リンク リソースは拒否されており、使用できません。

Sku

価格レベルと容量の制限を決定する、Azure Cognitive Search サービスの SKU を定義します。

Name Type Description
name

検索サービスの 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 個のパーティションをサポートします。

Name Type Description
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 個のパーティションをサポートする有料レベルの専用サービス。

UserAssignedManagedIdentity

検索サービスに割り当てられたユーザー割り当てマネージド ID の詳細。

Name Type Description
clientId
  • string

ユーザー割り当て ID のクライアント ID。

principalId
  • string

ユーザー割り当て ID のプリンシパル ID。