Microsoft.ApiManagement-service/-producten
Bicep-resourcedefinitie
Het resourcetype service/producten kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/products wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.ApiManagement/service/products@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Eigenschapswaarden
service/producten
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam Zie hoe u namen en typen instelt voor onderliggende resources in Bicep-. |
tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieke en afbreekstreepjes. Begin met letter en eindig met alfanumeriek. |
| ouder | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie. |
Symbolische naam voor resource van het type: service |
| Eigenschappen | Contracteigenschappen van productentiteit. | ProductContractProperties- |
ProductContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| approvalRequired | of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. | Bool |
| beschrijving | Productbeschrijving. Kan HTML-opmaaktags bevatten. | snaar Beperkingen: Maximale lengte = 1000 |
| displayName | Productnaam. | tekenreeks (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 300 |
| staat | of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd. | 'notPublished' "gepubliceerd" |
| subscriptionRequired | Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is. | Bool |
| subscriptionsLimit | Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. | Int |
| voorwaarde | Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien. | snaar |
Quickstart-sjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Sjabloon | Beschrijving |
|---|---|
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-
|
Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert |
|
Azure Front Door maken vóór Azure API Management
|
In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype service/producten kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.ApiManagement/service/products-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Eigenschapswaarden
service/producten
| Naam | Beschrijving | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.ApiManagement/service/products' |
| apiVersion | De versie van de resource-API | '2023-09-01-preview' |
| naam | De resourcenaam Zie hoe u namen en typen instelt voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieke en afbreekstreepjes. Begin met letter en eindig met alfanumeriek. |
| Eigenschappen | Contracteigenschappen van productentiteit. | ProductContractProperties- |
ProductContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| approvalRequired | of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. | Bool |
| beschrijving | Productbeschrijving. Kan HTML-opmaaktags bevatten. | snaar Beperkingen: Maximale lengte = 1000 |
| displayName | Productnaam. | tekenreeks (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 300 |
| staat | of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd. | 'notPublished' "gepubliceerd" |
| subscriptionRequired | Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is. | Bool |
| subscriptionsLimit | Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. | Int |
| voorwaarde | Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien. | snaar |
Quickstart-sjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Sjabloon | Beschrijving |
|---|---|
|
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-
|
Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert |
|
Azure Front Door maken vóór Azure API Management
|
In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype service/producten kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/products wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Eigenschapswaarden
service/producten
| Naam | Beschrijving | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.ApiManagement/service/products@2023-09-01-preview" |
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieke en afbreekstreepjes. Begin met letter en eindig met alfanumeriek. |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service- |
| Eigenschappen | Contracteigenschappen van productentiteit. | ProductContractProperties- |
ProductContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| approvalRequired | of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. | Bool |
| beschrijving | Productbeschrijving. Kan HTML-opmaaktags bevatten. | snaar Beperkingen: Maximale lengte = 1000 |
| displayName | Productnaam. | tekenreeks (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 300 |
| staat | of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd. | "notPublished" "gepubliceerd" |
| subscriptionRequired | Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is. | Bool |
| subscriptionsLimit | Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. | Int |
| voorwaarde | Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien. | snaar |