Dela via

Product - Get

  • Referens
Tjänst:
API Management
API-version:
2024-05-01

Hämtar information om den produkt som anges av dess identifierare.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2024-05-01

URI-parametrar

Name I Obligatorisk Typ Description
productId
 path True

string

minLength: 1
maxLength: 256

Produktidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Namnet på API Management-tjänsten.
subscriptionId
 path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.
api-version
 query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

ProductContract

Svarstexten innehåller den angivna produktentiteten.

Sidhuvuden

ETag: string
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementGetProduct

Exempelbegäran

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited?api-version=2024-05-01

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "unlimited",
  "properties": {
    "displayName": "Unlimited",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
ProductContract

Produktinformation.
ProductState

om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ProductContract

Objekt

Produktinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.approvalRequired

boolean

om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan någon av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.
properties.description

string

minLength: 0
maxLength: 1000

Produktbeskrivning. Kan innehålla HTML-formateringstaggar.
properties.displayName

string

minLength: 1
maxLength: 300

Produktnamn.
properties.state

ProductState

om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat.
properties.subscriptionRequired

boolean

Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när du skapar en ny produkt antas värdet vara sant.
properties.subscriptionsLimit

integer (int32)

Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna för att tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.
properties.terms

string

Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste acceptera dessa villkor innan de kan slutföra prenumerationsprocessen.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ProductState

Uppräkning

om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat.

Värde Description
notPublished
published