Accounts - Get
パラメーターで指定された Cognitive Services アカウントを返します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
account
|
path | True |
string |
Cognitive Services アカウントの名前。 正規表現パターン: |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
リソース プロバイダーは、操作が正常に完了したことを示すために 200 (OK) を返す必要があります。 応答本文の各フィールドの詳細については、「PUT リソース」セクションの要求本文の説明を参照してください。 GET 固有のプロパティは、"name"、"type"、"id" のみです。フィールドの説明の種類が必要です。 文字列 をオンにします。 この API アカウントの API セット。 それはすることができます ·1 つの API (Face API、Vision API、Speech API など)。 API のバンドル: Face + Speech、Vision + Emotion など sku.name 必要です。 この API の価格レベル/プラン。 可能: F0 - 無料 B0 - Basic S0 - Standard P0 - Premium |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 リソースが存在しない場合は、404 (NotFound) が返されます。 |
例
Get Account
要求のサンプル
応答のサンプル
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount",
"name": "myAccount",
"type": "Microsoft.CognitiveServices/accounts",
"location": "westus",
"sku": {
"name": "F0"
},
"kind": "Emotion",
"tags": {
"Owner": "felixwa",
"ExpiredDate": "2017/09/01"
},
"etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded"
}
}
定義
名前 | 説明 |
---|---|
Abuse |
不正使用のペナルティ。 |
Abuse |
AbusePenalty のアクション。 |
Account |
Cognitive Services アカウントは、プロビジョニングされたアカウント (種類、場所、SKU) を表す Azure リソースです。 |
Account |
Cognitive Services アカウントのプロパティ。 |
Api |
特殊な API の API プロパティ。 |
Call |
呼び出しレート制限 Cognitive Services アカウント。 |
Commitment |
コミットメント 計画の関連付け。 |
created |
リソースを作成した ID の種類。 |
Encryption |
暗号化を構成するプロパティ |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Identity |
リソースの ID。 |
Ip |
特定の IP アドレスまたは IP 範囲からのアクセシビリティを制御する規則。 |
key |
暗号化に使用できる keySource の値を列挙します |
Key |
keyVault プロパティを構成するプロパティ |
Multi |
マルチリージョン設定 Cognitive Services アカウント。 |
Network |
ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 |
Network |
ネットワーク アクセシビリティを管理する一連のルール。 |
Private |
プライベート エンドポイント リソース。 |
Private |
プライベート エンドポイント接続リソース。 |
Private |
PrivateEndpointConnectProperties のプロパティ。 |
Private |
現在のプロビジョニング状態。 |
Private |
プライベート エンドポイント接続の状態。 |
Private |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
Provisioning |
操作が呼び出されたときのコグニティブ サービス アカウントの状態を取得します。 |
Public |
このアカウントに対してパブリック エンドポイント アクセスが許可されているかどうか。 |
Quota |
|
Region |
呼び出しレート制限 Cognitive Services アカウント。 |
Request |
|
Resource |
ID の種類。 |
Routing |
マルチリージョン ルーティング方法。 |
Sku |
SKU を表すリソース モデル定義 |
Sku |
SkuCapability は、特定の機能の機能を示します。 |
Sku |
アカウントの SKU 変更情報。 |
Sku |
このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合は、リソース プロバイダーによって実装される必要があります。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Throttling |
|
User |
ユーザー割り当てマネージド ID。 |
User |
Cognitive Services アカウントのユーザー所有ストレージ。 |
Virtual |
特定の仮想ネットワークからのアクセシビリティを制御するルール。 |
AbusePenalty
不正使用のペナルティ。
名前 | 型 | 説明 |
---|---|---|
action |
AbusePenalty のアクション。 |
|
expiration |
string |
AbusePenalty の有効期限の日時。 |
rateLimitPercentage |
number |
レート制限の割合。 |
AbusePenaltyAction
AbusePenalty のアクション。
名前 | 型 | 説明 |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
Cognitive Services アカウントは、プロビジョニングされたアカウント (種類、場所、SKU) を表す Azure リソースです。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
リソース Etag。 |
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
リソースの ID。 |
|
kind |
string |
リソースの種類。 |
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties |
Cognitive Services アカウントのプロパティ。 |
|
sku |
SKU を表すリソース モデル定義 |
|
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
AccountProperties
Cognitive Services アカウントのプロパティ。
名前 | 型 | 説明 |
---|---|---|
abusePenalty |
不正使用のペナルティ。 |
|
allowedFqdnList |
string[] |
|
apiProperties |
特殊な API の API プロパティ。 |
|
callRateLimit |
呼び出しレート制限 Cognitive Services アカウント。 |
|
capabilities |
Cognitive Services アカウントの機能を取得します。 各項目は、特定の機能の機能を示します。 値は読み取り専用であり、参照専用です。 |
|
commitmentPlanAssociations |
Cognitive Services アカウントのコミットメント プランの関連付け。 |
|
customSubDomainName |
string |
トークンベースの認証に使用されるオプションのサブドメイン名。 |
dateCreated |
string |
Cognitive Services アカウントの作成日を取得します。 |
deletionDate |
string |
削除日。削除されたアカウントでのみ使用できます。 |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
動的な調整を有効にするフラグ。 |
encryption |
このリソースの暗号化プロパティ。 |
|
endpoint |
string |
作成されたアカウントのエンドポイント。 |
endpoints |
object |
|
internalId |
string |
内部識別子 (非推奨、このプロパティは使用しないでください)。 |
isMigrated |
boolean |
リソースが既存のキーから移行された場合。 |
locations |
Cognitive Services アカウントのマルチリージョン設定。 |
|
migrationToken |
string |
リソース移行トークン。 |
networkAcls |
特定のネットワークの場所からのアクセシビリティを管理するルールのコレクション。 |
|
privateEndpointConnections |
Cognitive Services アカウントに関連付けられているプライベート エンドポイント接続。 |
|
provisioningState |
操作が呼び出されたときのコグニティブ サービス アカウントの状態を取得します。 |
|
publicNetworkAccess |
このアカウントに対してパブリック エンドポイント アクセスが許可されているかどうか。 |
|
quotaLimit | ||
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
スケジュールされた消去日。削除されたアカウントでのみ使用できます。 |
skuChangeInfo |
アカウントの SKU 変更情報。 |
|
userOwnedStorage |
このリソースのストレージ アカウント。 |
ApiProperties
特殊な API の API プロパティ。
名前 | 型 | 説明 |
---|---|---|
aadClientId |
string |
(Metrics Advisor のみ)Azure AD クライアント ID (アプリケーション ID)。 |
aadTenantId |
string |
(Metrics Advisor のみ)Azure AD テナント ID。 |
eventHubConnectionString |
string |
(個人用設定のみ)Bing 検索の統計を有効にするフラグ。 |
qnaAzureSearchEndpointId |
string |
(QnAMaker のみ)QnAMaker の Azure Search エンドポイント ID。 |
qnaAzureSearchEndpointKey |
string |
(QnAMaker のみ)QnAMaker の Azure Search エンドポイント キー。 |
qnaRuntimeEndpoint |
string |
(QnAMaker のみ)QnAMaker のランタイム エンドポイント。 |
statisticsEnabled |
boolean |
(Bing 検索のみ) Bing 検索の統計を有効にするフラグ。 |
storageAccountConnectionString |
string |
(個人用設定のみ)ストレージ アカウント接続文字列。 |
superUser |
string |
(Metrics Advisor のみ)Metrics Advisor のスーパー ユーザー。 |
websiteName |
string |
(Metrics Advisor のみ)Metrics Advisor の Web サイト名。 |
CallRateLimit
呼び出しレート制限 Cognitive Services アカウント。
名前 | 型 | 説明 |
---|---|---|
count |
number |
呼び出しレート制限のカウント値。 |
renewalPeriod |
number |
通話レート制限の更新期間 (秒単位)。 |
rules |
CommitmentPlanAssociation
コミットメント 計画の関連付け。
名前 | 型 | 説明 |
---|---|---|
commitmentPlanId |
string |
コミットメント プランの Azure リソース ID。 |
commitmentPlanLocation |
string |
コミットメント 計画の場所。 |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
暗号化を構成するプロパティ
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
keySource | Microsoft.KeyVault |
暗号化に使用できる keySource の値を列挙します |
|
keyVaultProperties |
KeyVault のプロパティ |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
Identity
リソースの ID。
名前 | 型 | 説明 |
---|---|---|
principalId |
string |
リソース ID のプリンシパル ID。 |
tenantId |
string |
リソースのテナント ID。 |
type |
ID の種類。 |
|
userAssignedIdentities |
<string,
User |
リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 |
IpRule
特定の IP アドレスまたは IP 範囲からのアクセシビリティを制御する規則。
名前 | 型 | 説明 |
---|---|---|
value |
string |
CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純 IP アドレス) または '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 |
keySource
暗号化に使用できる keySource の値を列挙します
名前 | 型 | 説明 |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
keyVault プロパティを構成するプロパティ
名前 | 型 | 説明 |
---|---|---|
identityClientId |
string |
|
keyName |
string |
KeyVault からのキーの名前 |
keyVaultUri |
string |
KeyVault の URI |
keyVersion |
string |
KeyVault からのキーのバージョン |
MultiRegionSettings
マルチリージョン設定 Cognitive Services アカウント。
名前 | 型 | 説明 |
---|---|---|
regions |
呼び出しレート制限 Cognitive Services アカウント。 |
|
routingMethod |
マルチリージョン ルーティング方法。 |
NetworkRuleAction
ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。
名前 | 型 | 説明 |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
ネットワーク アクセシビリティを管理する一連のルール。
名前 | 型 | 説明 |
---|---|---|
defaultAction |
ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 |
|
ipRules |
Ip |
IP アドレス規則の一覧。 |
virtualNetworkRules |
仮想ネットワーク規則の一覧。 |
PrivateEndpoint
プライベート エンドポイント リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
プライベート エンドポイントの ARM 識別子 |
PrivateEndpointConnection
プライベート エンドポイント接続リソース。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
リソース Etag。 |
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
プライベート エンドポイント接続の場所 |
name |
string |
リソースの名前 |
properties |
リソースのプロパティ。 |
|
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
PrivateEndpointConnectProperties のプロパティ。
名前 | 型 | 説明 |
---|---|---|
groupIds |
string[] |
プライベート リンク リソース グループ ID。 |
privateEndpoint |
プライベート エンドポイントのリソース。 |
|
privateLinkServiceConnectionState |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
|
provisioningState |
プライベート エンドポイント接続リソースのプロビジョニング状態。 |
PrivateEndpointConnectionProvisioningState
現在のプロビジョニング状態。
名前 | 型 | 説明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
プライベート エンドポイント接続の状態。
名前 | 型 | 説明 |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
名前 | 型 | 説明 |
---|---|---|
actionsRequired |
string |
サービス プロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。 |
description |
string |
接続の承認/拒否の理由。 |
status |
接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 |
ProvisioningState
操作が呼び出されたときのコグニティブ サービス アカウントの状態を取得します。
名前 | 型 | 説明 |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
ResolvingDNS |
string |
|
Succeeded |
string |
PublicNetworkAccess
このアカウントに対してパブリック エンドポイント アクセスが許可されているかどうか。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuotaLimit
名前 | 型 | 説明 |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RegionSetting
呼び出しレート制限 Cognitive Services アカウント。
名前 | 型 | 説明 |
---|---|---|
customsubdomain |
string |
リージョンをリージョン カスタム サブドメインにマップします。 |
name |
string |
リージョンの名前。 |
value |
number |
優先度または重み付けルーティング方法の値。 |
RequestMatchPattern
名前 | 型 | 説明 |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
ID の種類。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RoutingMethods
マルチリージョン ルーティング方法。
名前 | 型 | 説明 |
---|---|---|
Performance |
string |
|
Priority |
string |
|
Weighted |
string |
Sku
SKU を表すリソース モデル定義
名前 | 型 | 説明 |
---|---|---|
capacity |
integer |
SKU でスケールアウト/インがサポートされている場合は、容量整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。 |
family |
string |
同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 |
name |
string |
SKU の名前。 例 - P3。 通常は文字 +数値コードです |
size |
string |
SKU サイズ。 name フィールドがレベルと他の値の組み合わせである場合、これはスタンドアロン コードになります。 |
tier |
このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合は、リソース プロバイダーによって実装される必要があります。 |
SkuCapability
SkuCapability は、特定の機能の機能を示します。
名前 | 型 | 説明 |
---|---|---|
name |
string |
SkuCapability の名前。 |
value |
string |
SkuCapability の値。 |
SkuChangeInfo
アカウントの SKU 変更情報。
名前 | 型 | 説明 |
---|---|---|
countOfDowngrades |
number |
ダウングレードの数を取得します。 |
countOfUpgradesAfterDowngrades |
number |
ダウングレード後のアップグレードの数を取得します。 |
lastChangeDate |
string |
最後の変更日を取得します。 |
SkuTier
このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合は、リソース プロバイダーによって実装される必要があります。
名前 | 型 | 説明 |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
ThrottlingRule
名前 | 型 | 説明 |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
ユーザー割り当てマネージド ID。
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
この ID に関連付けられているクライアント アプリ ID。 |
principalId |
string |
この ID に関連付けられている Azure Active Directory プリンシパル ID。 |
UserOwnedStorage
Cognitive Services アカウントのユーザー所有ストレージ。
名前 | 型 | 説明 |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
Microsoft.Storage リソースの完全なリソース ID。 |
VirtualNetworkRule
特定の仮想ネットワークからのアクセシビリティを制御するルール。
名前 | 型 | 説明 |
---|---|---|
id |
string |
'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 |
ignoreMissingVnetServiceEndpoint |
boolean |
不足している vnet サービス エンドポイントを無視します。 |
state |
string |
仮想ネットワーク 規則の状態を取得します。 |