Tag Resource - List By Service
Címkékhez társított erőforrások gyűjteménye.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources?api-version=2024-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Az API Management szolgáltatás neve. |
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ó. |
$filter
|
query |
string |
| Mező | Használat | Támogatott operátorok | Támogatott függvények | |
|
$skip
|
query |
integer (int32) minimum: 0 |
Kihagyandó rekordok száma. |
|
$top
|
query |
integer (int32) minimum: 1 |
A visszaadni kívánt rekordok száma. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
TagResource-entitások gyűjteményét sorolja fel. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy miért nem sikerült a művelet. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
ApiManagementListTagResources
Mintakérelem
Mintaválasz
{
"value": [
{
"tag": {
"id": "/tags/apitag123",
"name": "awesomeTag"
},
"operation": {
"id": "/apis/echo-api/operations/create-resource",
"apiName": "Echo API",
"apiRevision": "1",
"name": "Create resource",
"method": "POST",
"urlTemplate": "/resource",
"description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."
}
},
{
"tag": {
"id": "/tags/apitag123",
"name": "awesomeTag"
},
"api": {
"id": "/apis/echo-api",
"name": "Echo API",
"apiRevision": "1",
"serviceUrl": "http://echoapi.cloudapp.net/api",
"path": "echo",
"isCurrent": true
}
},
{
"tag": {
"id": "/tags/apitag123",
"name": "awesomeTag"
},
"product": {
"id": "/products/starter",
"name": "Starter",
"description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
"terms": "",
"subscriptionRequired": true,
"approvalRequired": false,
"subscriptionsLimit": 1,
"state": "published"
}
}
]
}
Definíciók
Name | Description |
---|---|
Api |
AZ API kapcsolattartási adatai |
Api |
API-licencinformációk |
Api |
API-szerződés tulajdonságai a címkeerőforrásokhoz. |
Api |
Az API típusa. |
Authentication |
API-hitelesítési beállítások. |
bearer |
Jogkivonat küldése a kiszolgálóra. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
OAuth2Authentication |
AZ API OAuth2 hitelesítési beállításainak részletei. |
Open |
AZ API OAuth2 hitelesítési beállításainak részletei. |
Operation |
Műveletentitási szerződés tulajdonságai. |
Product |
függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve. |
Product |
Termékprofil. |
Protocol |
Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg. |
Subscription |
Az előfizetéskulcs paraméterneveinek részletei. |
Tag |
Lapozott címkelista ábrázolása. |
Tag |
TagResource szerződés tulajdonságai. |
Tag |
A Címke tulajdonságot meghatározó szerződés a címkeerőforrás-szerződésben |
ApiContactInformation
AZ API kapcsolattartási adatai
Name | Típus | Description |
---|---|---|
string |
A kapcsolattartó/szervezet e-mail-címe. E-mail-cím formátumúnak kell lennie |
|
name |
string |
A kapcsolattartó/szervezet azonosító neve |
url |
string |
A kapcsolattartási adatokra mutató URL-cím. URL-cím formátumban kell lennie |
ApiLicenseInformation
API-licencinformációk
Name | Típus | Description |
---|---|---|
name |
string |
Az API-hoz használt licencnév |
url |
string |
Az API-hoz használt licenc URL-címe. URL-cím formátumban kell lennie |
ApiTagResourceContractProperties
API-szerződés tulajdonságai a címkeerőforrásokhoz.
Name | Típus | Description |
---|---|---|
apiRevision |
string minLength: 1maxLength: 100 |
Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, a rendszer létrehozza az 1. alapértelmezett változatot |
apiRevisionDescription |
string maxLength: 256 |
Az API-változat leírása. |
apiVersion |
string maxLength: 100 |
Az API verzióazonosítóját jelzi, ha az API verziószámozott |
apiVersionDescription |
string maxLength: 256 |
Az API-verzió leírása. |
apiVersionSetId |
string |
A kapcsolódó ApiVersionSet erőforrás-azonosítója. |
authenticationSettings |
Az API-ba foglalt hitelesítési beállítások gyűjteménye. |
|
contact |
Az API kapcsolattartási adatai. |
|
description |
string |
Az API leírása. HTML-formázási címkéket is tartalmazhat. |
id |
string |
API-azonosító az /apis/{apiId} formában. |
isCurrent |
boolean |
Azt jelzi, hogy az API-változat aktuális API-változat-e. |
isOnline |
boolean |
Azt jelzi, hogy az API-változat elérhető-e az átjárón keresztül. |
license |
Az API licencadatai. |
|
name |
string minLength: 1maxLength: 300 |
API-név. |
path |
string minLength: 0maxLength: 400 |
Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végpontbázis URL-címéhez, hogy nyilvános URL-címet képezze ehhez az API-hoz. |
protocols |
Protocol[] |
Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg. |
serviceUrl |
string minLength: 1maxLength: 2000 |
Az API-t implementáló háttérszolgáltatás abszolút URL-címe. |
subscriptionKeyParameterNames |
Protokollok, amelyeken keresztül az API elérhetővé válik. |
|
subscriptionRequired |
boolean |
Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez. |
termsOfServiceUrl |
string |
Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie. |
type |
Az API típusa. |
ApiType
Az API típusa.
Érték | Description |
---|---|
graphql | |
grpc | |
http | |
odata | |
soap | |
websocket |
AuthenticationSettingsContract
API-hitelesítési beállítások.
Name | Típus | Description |
---|---|---|
oAuth2 |
OAuth2 hitelesítési beállítások |
|
oAuth2AuthenticationSettings |
Az API-ben található OAuth2 hitelesítési beállítások gyűjteménye. |
|
openid |
OpenID Connect-hitelesítési beállítások |
|
openidAuthenticationSettings |
Az API-hoz tartozó Open ID Connect hitelesítési beállítások gyűjteménye. |
bearerTokenSendingMethods
Jogkivonat küldése a kiszolgálóra.
Érték | Description |
---|---|
authorizationHeader |
A hozzáférési jogkivonat az Engedélyezési fejlécben lesz továbbítva a Bearer-sémával |
query |
A hozzáférési jogkivonat lekérdezési paraméterekként lesz továbbítva. |
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. |
OAuth2AuthenticationSettingsContract
AZ API OAuth2 hitelesítési beállításainak részletei.
Name | Típus | Description |
---|---|---|
authorizationServerId |
string |
OAuth engedélyezési kiszolgáló azonosítója. |
scope |
string |
műveleti hatókör. |
OpenIdAuthenticationSettingsContract
AZ API OAuth2 hitelesítési beállításainak részletei.
Name | Típus | Description |
---|---|---|
bearerTokenSendingMethods |
Jogkivonat küldése a kiszolgálóra. |
|
openidProviderId |
string |
OAuth engedélyezési kiszolgáló azonosítója. |
OperationTagResourceContractProperties
Műveletentitási szerződés tulajdonságai.
Name | Típus | Description |
---|---|---|
apiName |
string |
API-név. |
apiRevision |
string |
API-változat. |
apiVersion |
string |
API-verzió. |
description |
string |
Művelet leírása. |
id |
string |
A művelet azonosítója formában /operations/{operationId}. |
method |
string |
Érvényes HTTP-műveleti módszer. Tipikus HTTP-metódusok, például GET, PUT, POST, de nem csak ezek. |
name |
string |
Művelet neve. |
urlTemplate |
string |
A művelet célerőforrását azonosító relatív URL-sablon. Tartalmazhat paramétereket. Példa: /customers/{cid}/orders/{oid}/?date={date} |
ProductState
függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve.
Érték | Description |
---|---|
notPublished | |
published |
ProductTagResourceContractProperties
Termékprofil.
Name | Típus | Description |
---|---|---|
approvalRequired |
boolean |
az előfizetés jóváhagyására van-e szükség. Ha hamis, a rendszer automatikusan jóváhagyja az új előfizetéseket, így a fejlesztők közvetlenül a feliratkozás után meghívhatják a termék API-jait. Ha igaz, a rendszergazdáknak manuálisan jóvá kell hagyniuk az előfizetést, mielőtt a fejlesztő bármelyik termék API-ját használhatja. Csak akkor lehet jelen, ha az subscriptionRequired tulajdonság jelen van, és értéke hamis. |
description |
string minLength: 0maxLength: 1000 |
Termék leírása. HTML-formázási címkéket is tartalmazhat. |
id |
string |
A termék azonosítója /products/{productId} formában |
name |
string minLength: 1maxLength: 300 |
Terméknév. |
state |
függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve. |
|
subscriptionRequired |
boolean |
Az, hogy szükség van-e termék-előfizetésre a termékben található API-k eléréséhez. Ha igaz, a termék neve "védett", és érvényes előfizetési kulcs szükséges a termékben található API-ra irányuló kérés sikerességéhez. Ha hamis, a termék neve "nyitott", és a termékben szereplő API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha egy új termék létrehozásakor a tulajdonság nincs megadva, akkor az értéke igaznak lesz feltételezve. |
subscriptionsLimit |
integer (int32) |
Azt jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra, hogy felhasználói előfizetésenként korlátlan legyen. Csak akkor lehet jelen, ha az subscriptionRequired tulajdonság jelen van, és értéke hamis. |
terms |
string |
Termék használati feltételei. A termékre feliratkozni próbáló fejlesztők megjelennek, és el kell fogadniuk ezeket a feltételeket, mielőtt befejezhetik az előfizetési folyamatot. |
Protocol
Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.
Érték | Description |
---|---|
http | |
https | |
ws | |
wss |
SubscriptionKeyParameterNamesContract
Az előfizetéskulcs paraméterneveinek részletei.
Name | Típus | Description |
---|---|---|
header |
string |
Az előfizetéskulcs fejlécének neve. |
query |
string |
Előfizetési kulcs lekérdezési sztring paraméterének neve. |
TagResourceCollection
Lapozott címkelista ábrázolása.
Name | Típus | Description |
---|---|---|
count |
integer (int64) |
Összes rekordszám az összes oldalon. |
nextLink |
string |
Ha van ilyen, a következő oldal hivatkozása. |
value |
Oldalértékek. |
TagResourceContract
TagResource szerződés tulajdonságai.
Name | Típus | Description |
---|---|---|
api |
A címkéhez társított API. |
|
operation |
A címkéhez társított művelet. |
|
product |
A címkéhez társított termék. |
|
tag |
Az erőforráshoz társított címke. |
TagTagResourceContractProperties
A Címke tulajdonságot meghatározó szerződés a címkeerőforrás-szerződésben
Name | Típus | Description |
---|---|---|
id |
string |
Címkeazonosító |
name |
string minLength: 1maxLength: 160 |
Címke neve |