Microsoft.ApiManagement service/products 2021-04-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/products kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/products-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/products@2021-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Eigenschaftswerte
service/products
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: Dienst |
properties | Eigenschaften des Produktentitätsvertrags. | ProductContractProperties |
ProductContractProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
approvalRequired | gibt an, ob eine Abonnementgenehmigung erforderlich ist. Bei false werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die Eigenschaft subscriptionRequired vorhanden ist und den Wert false aufweist. | bool |
description | Produktbeschreibung. Kann HTML-Formatierungstags umfassen. | Zeichenfolge |
displayName | Produktname | Zeichenfolge (erforderlich) |
state | ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals auffindbar sein. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht. | "notPublished" "veröffentlicht" |
subscriptionRequired | Gibt an, ob ein Produktabonnement für den Zugriff auf in diesem Produkt enthaltene APIs erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, damit eine Anforderung an eine im Produkt enthaltene API erfolgreich ist. Wenn false, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine api, die im Produkt enthalten ist, können ohne einen Abonnementschlüssel erfolgen. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist. | bool |
subscriptionsLimit | Gibt an, wie viele Abonnements ein Benutzer gleichzeitig für dieses Produkt haben kann. Legen Sie diesen Wert auf NULL fest oder lassen Sie es aus, um unbegrenzte Anzahl von Abonnements pro Benutzer zuzulassen. Kann nur vorhanden sein, wenn die Eigenschaft subscriptionRequired vorhanden ist und den Wert false aufweist. | INT |
terms | Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können. | Zeichenfolge |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren. |
Erstellen von Azure Front Door vor Azure API Management |
In diesem Beispiel wird veranschaulicht, wie Sie Azure Front Door als globalen Lastenausgleich vor Azure API Management verwenden. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/products kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/products-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2021-04-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Eigenschaftswerte
service/products
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.ApiManagement/service/products" |
apiVersion | Die Ressourcen-API-Version | "2021-04-01-preview" |
name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
properties | Eigenschaften des Produktentitätsvertrags. | ProductContractProperties |
ProductContractProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
approvalRequired | gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn false, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts sofort nach dem Abonnement aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist. | bool |
description | Produktbeschreibung. Kann HTML-Formatierungstags umfassen. | Zeichenfolge |
displayName | Produktname | Zeichenfolge (erforderlich) |
state | ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals gefunden werden. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht. | "notPublished" "veröffentlicht" |
subscriptionRequired | Gibt an, ob ein Produktabonnement für den Zugriff auf in diesem Produkt enthaltene APIs erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, damit eine Anforderung an eine im Produkt enthaltene API erfolgreich ist. Wenn false, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine im Produkt enthaltene API können ohne Abonnementschlüssel gestellt werden. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist. | bool |
subscriptionsLimit | Gibt an, wie viele Abonnements ein Benutzer für dieses Produkt gleichzeitig haben kann. Legen Sie auf NULL fest oder lassen Sie aus, um unbegrenzte Anzahl pro Benutzerabonnement zuzulassen. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist. | INT |
terms | Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können. | Zeichenfolge |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren. |
Erstellen von Azure Front Door vor Azure API Management |
In diesem Beispiel wird veranschaulicht, wie Sie Azure Front Door als globalen Lastenausgleich vor Azure API Management verwenden. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp Dienst/Produkte kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/products-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2021-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Eigenschaftswerte
service/products
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.ApiManagement/service/products@2021-04-01-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
parent_id | Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. | ID für Ressource vom Typ: Dienst |
properties | Eigenschaften des Produktentitätsvertrags. | ProductContractProperties |
ProductContractProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
approvalRequired | gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn false, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts sofort nach dem Abonnement aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die Eigenschaft subscriptionRequired vorhanden ist und den Wert false aufweist. | bool |
description | Produktbeschreibung. Kann HTML-Formatierungstags umfassen. | Zeichenfolge |
displayName | Produktname | Zeichenfolge (erforderlich) |
state | ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals auffindbar sein. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht. | "notPublished" "veröffentlicht" |
subscriptionRequired | Gibt an, ob ein Produktabonnement für den Zugriff auf in diesem Produkt enthaltene APIs erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, damit eine Anforderung an eine im Produkt enthaltene API erfolgreich ist. Wenn false, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine api, die im Produkt enthalten ist, können ohne einen Abonnementschlüssel erfolgen. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist. | bool |
subscriptionsLimit | Gibt an, wie viele Abonnements ein Benutzer gleichzeitig für dieses Produkt haben kann. Legen Sie diesen Wert auf NULL fest oder lassen Sie es aus, um unbegrenzte Anzahl von Abonnements pro Benutzer zuzulassen. Kann nur vorhanden sein, wenn die Eigenschaft subscriptionRequired vorhanden ist und den Wert false aufweist. | INT |
terms | Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können. | Zeichenfolge |