Aracılığıyla paylaş


Accounts - Get

Parametreler tarafından belirtilen bir Bilişsel Hizmetler hesabı döndürür.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01

URI Parametreleri

Name İçinde Gerekli Tür Description
accountName
path True

string

Bilişsel Hizmetler hesabının adı.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.

subscriptionId
path True

string

Hedef aboneliğin kimliği.

api-version
query True

string

Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name Tür Description
200 OK

Account

İşlemin başarıyla tamamlandığını belirtmek için kaynak sağlayıcısı 200 (Tamam) döndürmelidir. Yanıt gövdesindeki her alanın ayrıntılı açıklaması için lütfen PUT kaynağı bölümündeki istek gövdesi açıklamasına bakın. GET'e özgü özellikler yalnızca "name", "type" ve "id" şeklindedir. Alan Açıklaması Türü gerekli. Dize. Bu API hesabı için ayarlanan API. · olabilir tek bir API, örneğin: Yüz Tanıma API'si, Görüntü İşleme API'si, Konuşma API'si. API'lerden oluşan bir paket: Yüz + Konuşma, Görüntü İşleme + Duygu vb. sku.name Gerekli. Bu API'nin fiyatlandırma katmanı/planı. Olabilir: F0 - Ücretsiz B0 - Temel S0 - Standart P0 - Premium

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı. Kaynak yoksa 404 (NotFound) döndürülmelidir.

Örnekler

Get Account

Sample Request

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount?api-version=2023-05-01

Sample Response

{
  "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"
  }
}

Tanımlar

Name Description
AbusePenalty

Suistimal cezası.

AbusePenaltyAction

AbusePenalty eylemi.

Account

Bilişsel Hizmetler hesabı sağlanan hesabı, türü, konumu ve SKU'su temsil eden bir Azure kaynağıdır.

AccountProperties

Bilişsel Hizmetler hesabının özellikleri.

ApiProperties

Özel API'ler için api özellikleri.

CallRateLimit

Çağrı oranı sınırı Bilişsel Hizmetler hesabı.

CommitmentPlanAssociation

Taahhüt planı ilişkisi.

createdByType

Kaynağı oluşturan kimliğin türü.

Encryption

Şifrelemeyi yapılandırmak için özellikler

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

Identity

Kaynağın kimliği.

IpRule

Belirli bir ip adresinden veya ip aralığından erişilebilirliği yöneten bir kural.

keySource

Şifreleme için keySource'un olası değerini numaralandırır

KeyVaultProperties

keyVault Özelliklerini yapılandıracak özellikler

MultiRegionSettings

Çoklu bölge ayarları Bilişsel Hizmetler hesabı.

NetworkRuleAction

ipRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca atlama özelliği değerlendirildikten sonra kullanılır.

NetworkRuleSet

Ağ erişilebilirliğini yöneten bir dizi kural.

PrivateEndpoint

Özel Uç Nokta kaynağı.

PrivateEndpointConnection

Özel Uç Nokta Bağlantısı kaynağı.

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties özellikleri.

PrivateEndpointConnectionProvisioningState

Geçerli sağlama durumu.

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

ProvisioningState

İşlem çağrıldığında bilişsel hizmetler hesabının durumunu alır.

PublicNetworkAccess

Bu hesap için genel uç nokta erişimine izin verilip verilmeyeceği.

QuotaLimit
RegionSetting

Çağrı oranı sınırı Bilişsel Hizmetler hesabı.

RequestMatchPattern
ResourceIdentityType

Kimlik türü.

RoutingMethods

Çoklu bölge yönlendirme yöntemleri.

Sku

SKU'yu temsil eden kaynak modeli tanımı

SkuCapability

SkuCapability, belirli bir özelliğin özelliğini gösterir.

SkuChangeInfo

Hesabın Sku değişiklik bilgileri.

SkuTier

Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

ThrottlingRule
UserAssignedIdentity

Kullanıcı tarafından atanan yönetilen kimlik.

UserOwnedStorage

Bilişsel Hizmetler hesabı için kullanıcıya ait depolama alanı.

VirtualNetworkRule

Belirli bir sanal ağdan erişilebilirliği yöneten bir kural.

AbusePenalty

Suistimal cezası.

Name Tür Description
action

AbusePenaltyAction

AbusePenalty eylemi.

expiration

string

AbusePenalty değerinin sona erme tarihi.

rateLimitPercentage

number

Oran sınırının yüzdesi.

AbusePenaltyAction

AbusePenalty eylemi.

Name Tür Description
Block

string

Throttle

string

Account

Bilişsel Hizmetler hesabı sağlanan hesabı, türü, konumu ve SKU'su temsil eden bir Azure kaynağıdır.

Name Tür Description
etag

string

Kaynak Etag'i.

id

string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Kaynağın kimliği.

kind

string

Kaynağın türü.

location

string

Kaynağın bulunduğu coğrafi konum

name

string

Kaynağın adı

properties

AccountProperties

Bilişsel Hizmetler hesabının özellikleri.

sku

Sku

SKU'yu temsil eden kaynak modeli tanımı

systemData

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

tags

object

Kaynak etiketleri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

AccountProperties

Bilişsel Hizmetler hesabının özellikleri.

Name Tür Description
abusePenalty

AbusePenalty

Suistimal cezası.

allowedFqdnList

string[]

apiProperties

ApiProperties

Özel API'ler için api özellikleri.

callRateLimit

CallRateLimit

Çağrı hızı sınırı Bilişsel Hizmetler hesabı.

capabilities

SkuCapability[]

Bilişsel hizmetler hesabının özelliklerini alır. Her öğe belirli bir özelliğin özelliğini gösterir. Değerler salt okunur ve yalnızca başvuru amaçlıdır.

commitmentPlanAssociations

CommitmentPlanAssociation[]

Bilişsel Hizmetler hesabının taahhüt planı ilişkilendirmeleri.

customSubDomainName

string

Belirteç tabanlı kimlik doğrulaması için kullanılan isteğe bağlı alt etki alanı adı.

dateCreated

string

Bilişsel hizmetler hesabı oluşturma tarihini alır.

deletionDate

string

Silme tarihi, yalnızca silinen hesap için kullanılabilir.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

Dinamik azaltmayı etkinleştirmek için bayrağı.

encryption

Encryption

Bu kaynağın şifreleme özellikleri.

endpoint

string

Oluşturulan hesabın uç noktası.

endpoints

object

internalId

string

İç tanımlayıcı (kullanım dışıdır, bu özelliği kullanmayın).

isMigrated

boolean

Kaynak mevcut bir anahtardan geçirildiyse.

locations

MultiRegionSettings

Bilişsel Hizmetler hesabının çoklu bölge ayarları.

migrationToken

string

Kaynak geçiş belirteci.

networkAcls

NetworkRuleSet

Belirli ağ konumlarından erişilebilirliği yöneten kurallar koleksiyonu.

privateEndpointConnections

PrivateEndpointConnection[]

Bilişsel Hizmetler hesabıyla ilişkili özel uç nokta bağlantısı.

provisioningState

ProvisioningState

İşlem çağrıldığında bilişsel hizmetler hesabının durumunu alır.

publicNetworkAccess

PublicNetworkAccess

Bu hesap için genel uç nokta erişimine izin verilip verilmeyeceği.

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

Zamanlanmış temizleme tarihi; yalnızca silinen hesap için kullanılabilir.

skuChangeInfo

SkuChangeInfo

Hesabın Sku değişiklik bilgileri.

userOwnedStorage

UserOwnedStorage[]

Bu kaynağın depolama hesabı.

ApiProperties

Özel API'ler için api özellikleri.

Name Tür Description
aadClientId

string

(Yalnızca Ölçüm Danışmanı) Azure AD İstemci Kimliği (Uygulama Kimliği).

aadTenantId

string

(Yalnızca Ölçüm Danışmanı) Azure AD Kiracı Kimliği.

eventHubConnectionString

string

(Yalnızca Kişiselleştirme) Bing Arama istatistiklerini etkinleştirme bayrağı.

qnaAzureSearchEndpointId

string

(Yalnızca Soru-Cevap Oluşturma) QnAMaker'ın Azure Search uç nokta kimliği.

qnaAzureSearchEndpointKey

string

(Yalnızca Soru-Cevap Oluşturma) QnAMaker'ın Azure Search uç nokta anahtarı.

qnaRuntimeEndpoint

string

(Yalnızca Soru-Cevap Oluşturma) QnAMaker'ın çalışma zamanı uç noktası.

statisticsEnabled

boolean

(Yalnızca Bing Arama) Bing Arama istatistiklerini etkinleştirme bayrağı.

storageAccountConnectionString

string

(Yalnızca Kişiselleştirme) Depolama hesabı bağlantı dizesi.

superUser

string

(Yalnızca Ölçüm Danışmanı) Ölçüm Danışmanı'nın süper kullanıcısı.

websiteName

string

(Yalnızca Ölçüm Danışmanı) Ölçüm Danışmanı'nın web sitesi adı.

CallRateLimit

Çağrı oranı sınırı Bilişsel Hizmetler hesabı.

Name Tür Description
count

number

Çağrı Hızı Sınırı'nın sayı değeri.

renewalPeriod

number

Arama Hızı Sınırı'nın saniye cinsinden yenileme süresi.

rules

ThrottlingRule[]

CommitmentPlanAssociation

Taahhüt planı ilişkisi.

Name Tür Description
commitmentPlanId

string

Taahhüt planının Azure kaynak kimliği.

commitmentPlanLocation

string

Taahhüt planının konumu.

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

Şifrelemeyi yapılandırmak için özellikler

Name Tür Varsayılan değer Description
keySource

keySource

Microsoft.KeyVault

Şifreleme için keySource'un olası değerini numaralandırır

keyVaultProperties

KeyVaultProperties

KeyVault Özellikleri

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

Identity

Kaynağın kimliği.

Name Tür Description
principalId

string

Kaynak kimliğinin asıl kimliği.

tenantId

string

Kaynağın kiracı kimliği.

type

ResourceIdentityType

Kimlik türü.

userAssignedIdentities

<string,  UserAssignedIdentity>

Kaynakla ilişkili kullanıcı tarafından atanan kimliklerin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Belirli bir ip adresinden veya ip aralığından erişilebilirliği yöneten bir kural.

Name Tür Description
value

string

'124.56.78.91' (basit IP adresi) veya '124.56.78.0/24' gibi CIDR gösterimindeki bir IPv4 adres aralığı (124.56.78 ile başlayan tüm adresler).

keySource

Şifreleme için keySource'un olası değerini numaralandırır

Name Tür Description
Microsoft.CognitiveServices

string

Microsoft.KeyVault

string

KeyVaultProperties

keyVault Özelliklerini yapılandıracak özellikler

Name Tür Description
identityClientId

string

keyName

string

KeyVault'tan Anahtarın Adı

keyVaultUri

string

KeyVault'un Uri'si

keyVersion

string

KeyVault'tan Anahtarın Sürümü

MultiRegionSettings

Çoklu bölge ayarları Bilişsel Hizmetler hesabı.

Name Tür Description
regions

RegionSetting[]

Çağrı oranı sınırı Bilişsel Hizmetler hesabı.

routingMethod

RoutingMethods

Çoklu bölge yönlendirme yöntemleri.

NetworkRuleAction

ipRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca atlama özelliği değerlendirildikten sonra kullanılır.

Name Tür Description
Allow

string

Deny

string

NetworkRuleSet

Ağ erişilebilirliğini yöneten bir dizi kural.

Name Tür Description
defaultAction

NetworkRuleAction

ipRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.

ipRules

IpRule[]

IP adresi kurallarının listesi.

virtualNetworkRules

VirtualNetworkRule[]

Sanal ağ kurallarının listesi.

PrivateEndpoint

Özel Uç Nokta kaynağı.

Name Tür Description
id

string

Özel Uç Nokta için ARM tanımlayıcısı

PrivateEndpointConnection

Özel Uç Nokta Bağlantısı kaynağı.

Name Tür Description
etag

string

Kaynak Etag'i.

id

string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Özel uç nokta bağlantısının konumu

name

string

Kaynağın adı

properties

PrivateEndpointConnectionProperties

Kaynak özellikleri.

systemData

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties özellikleri.

Name Tür Description
groupIds

string[]

Özel bağlantı kaynak grubu kimlikleri.

privateEndpoint

PrivateEndpoint

Özel uç noktanın kaynağı.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

provisioningState

PrivateEndpointConnectionProvisioningState

Özel uç nokta bağlantı kaynağının sağlama durumu.

PrivateEndpointConnectionProvisioningState

Geçerli sağlama durumu.

Name Tür Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

Name Tür Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

Name Tür Description
actionsRequired

string

Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.

description

string

Bağlantının onay/reddedilme nedeni.

status

PrivateEndpointServiceConnectionStatus

Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.

ProvisioningState

İşlem çağrıldığında bilişsel hizmetler hesabının durumunu alır.

Name Tür Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Moving

string

ResolvingDNS

string

Succeeded

string

PublicNetworkAccess

Bu hesap için genel uç nokta erişimine izin verilip verilmeyeceği.

Name Tür Description
Disabled

string

Enabled

string

QuotaLimit

Name Tür Description
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RegionSetting

Çağrı oranı sınırı Bilişsel Hizmetler hesabı.

Name Tür Description
customsubdomain

string

Bölgeyi bölgesel özel alt etki alanıyla eşler.

name

string

Bölgenin adı.

value

number

Öncelik veya ağırlıklı yönlendirme yöntemleri için bir değer.

RequestMatchPattern

Name Tür Description
method

string

path

string

ResourceIdentityType

Kimlik türü.

Name Tür Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RoutingMethods

Çoklu bölge yönlendirme yöntemleri.

Name Tür Description
Performance

string

Priority

string

Weighted

string

Sku

SKU'yu temsil eden kaynak modeli tanımı

Name Tür Description
capacity

integer

SKU ölçeği genişletmeyi/daraltma işlemini destekliyorsa kapasite tamsayısı dahil edilmelidir. Kaynak için ölçeği genişletme/daraltma mümkün değilse bu atlanabilir.

family

string

Hizmetin aynı SKU için farklı nesil donanımları varsa, bu durum burada yakalanabilir.

name

string

SKU'nun adı. Ex - P3. Bu genellikle bir harf+sayı kodudur

size

string

SKU boyutu. Ad alanı katman ve başka bir değerin birleşimi olduğunda, bu tek başına kod olacaktır.

tier

SkuTier

Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

SkuCapability

SkuCapability, belirli bir özelliğin özelliğini gösterir.

Name Tür Description
name

string

SkuCapability adı.

value

string

SkuCapability değeri.

SkuChangeInfo

Hesabın Sku değişiklik bilgileri.

Name Tür Description
countOfDowngrades

number

Eski sürüm sayısını alır.

countOfUpgradesAfterDowngrades

number

Eski sürüme düşürme sonrasında yapılan yükseltmelerin sayısını alır.

lastChangeDate

string

Son değişiklik tarihini alır.

SkuTier

Hizmetin birden fazla katmanı varsa ancak PUT üzerinde gerekli değilse, bu alanın Kaynak Sağlayıcısı tarafından uygulanması gerekir.

Name Tür Description
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

ThrottlingRule

Name Tür Description
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

Kullanıcı tarafından atanan yönetilen kimlik.

Name Tür Description
clientId

string

Bu kimlikle ilişkili İstemci Uygulama Kimliği.

principalId

string

Bu Kimlikle ilişkili Azure Active Directory asıl kimliği.

UserOwnedStorage

Bilişsel Hizmetler hesabı için kullanıcıya ait depolama alanı.

Name Tür Description
identityClientId

string

resourceId

string

Microsoft.Storage kaynağının tam kaynak kimliği.

VirtualNetworkRule

Belirli bir sanal ağdan erişilebilirliği yöneten bir kural.

Name Tür Description
id

string

'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' gibi bir sanal ağ alt ağının tam kaynak kimliği.

ignoreMissingVnetServiceEndpoint

boolean

Eksik sanal ağ hizmet uç noktasını yoksayın veya yoksayın.

state

string

Sanal ağ kuralının durumunu alır.