Create Api Key - Post
Létrehoz egy API-kulcsot, amely hozzáférést biztosít a Marketplace Catalog API-k teljes tartományához. Vegye figyelembe, hogy ez az API jelenleg előzetes verziójú állapotban van, és regisztrálnia kell a "Discovery API Key Early Access" előzetes verziójú funkcióra egy érvényes Azure-előfizetés használatával. A folyamatról további információt a Marketplace Catalog API-k dokumentációjában talál, itt
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys/{apiKeyAlias}/create?api-version=2023-01-01-preview
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
api
|
path | True |
string |
Az új API-kulcs aliasa. Ennek az aliasnak egyedinek kell lennie, és csak kötőjelekkel elválasztott alfanumerikus karaktereket kell tartalmaznia. |
subscription
|
path | True |
string (uuid) |
A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie. |
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-tenant-id | True |
string |
Az előfizetéshez társított bérlő. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Az újonnan létrehozott API-kulcsot adja vissza. |
|
Other Status Codes |
A Microsoft.Marketplace hibaválasza leírja, hogy miért nem sikerült a művelet. |
Példák
Create_Key
Mintakérelem
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Marketplace/keys/key1/create?api-version=2023-01-01-preview
Mintaválasz
{
"keyAlias": "keyName",
"key": "keyValue"
}
Definíciók
Name | Description |
---|---|
Api |
A kulcsot és az aliast is tartalmazó ApiKey-objektum. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
ApiKey
A kulcsot és az aliast is tartalmazó ApiKey-objektum.
Name | Típus | Description |
---|---|---|
key |
string |
A releváns felderítési végpontok meghívásához használandó API-kulcs. |
keyAlias |
string |
Az API-kulcs aliasa. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |