Microsoft.ApiManagement service/workspaces/products 2022-09-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp "Service/workspaces/products" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.ApiManagement/service/workspaces/products" zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/products@2022-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Eigenschaftswerte
Microsoft.ApiManagement/service/workspaces/products
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Elternteil | 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 des Typs: Dienst/Arbeitsbereiche |
| Eigenschaften | Vertragseigenschaften für Produktentität. | ProductContractProperties |
ProductContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| approvalRequired | gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn "false" lautet, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren aufrufen können. Wenn dies der Fall ist, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler die APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist. | Bool |
| Beschreibung | Produktbeschreibung. Kann HTML-Formatierungstags enthalten. | Schnur Zwänge: Max. Länge = |
| displayName | Produktname. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Zustand | ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte sind von Benutzern des Entwicklerportals auffindbar. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nicht veröffentlicht. | "notPublished" "veröffentlicht" |
| subscriptionRequired | Gibt an, ob für den Zugriff auf in diesem Produkt enthaltene APIs ein Produktabonnement erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, um eine Anforderung an eine IM Produkt enthaltene API auszuführen. Wenn falsch, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine API, die im Produkt enthalten ist, können ohne Abonnementschlüssel erfolgen. Wenn die Eigenschaft beim Erstellen eines neuen Produkts nicht angegeben wird, wird davon ausgegangen, dass er wahr ist. | Bool |
| subscriptionsLimit | Gibt an, ob die Anzahl der Abonnements, die ein Benutzer gleichzeitig für dieses Produkt haben kann. Wird auf NULL festgelegt oder weggelassen, um unbegrenzte Anzahl pro Benutzerabonnements zuzulassen. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist. | Int |
| Bedingungen | Produktbedingungen. Entwickler, die versuchen, das Produkt zu abonnieren, werden präsentiert und müssen diese Bedingungen akzeptieren, bevor sie den Abonnementvorgang abschließen können. | Schnur |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "Service/workspaces/products" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/workspaces/products-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/workspaces/products",
"apiVersion": "2022-09-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Eigenschaftswerte
Microsoft.ApiManagement/service/workspaces/products
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2022-09-01-preview" |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Eigenschaften | Vertragseigenschaften für Produktentität. | ProductContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/workspaces/products" |
ProductContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| approvalRequired | gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn "false" lautet, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren aufrufen können. Wenn dies der Fall ist, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler die APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist. | Bool |
| Beschreibung | Produktbeschreibung. Kann HTML-Formatierungstags enthalten. | Schnur Zwänge: Max. Länge = |
| displayName | Produktname. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Zustand | ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte sind von Benutzern des Entwicklerportals auffindbar. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nicht veröffentlicht. | "notPublished" "veröffentlicht" |
| subscriptionRequired | Gibt an, ob für den Zugriff auf in diesem Produkt enthaltene APIs ein Produktabonnement erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, um eine Anforderung an eine IM Produkt enthaltene API auszuführen. Wenn falsch, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine API, die im Produkt enthalten ist, können ohne Abonnementschlüssel erfolgen. Wenn die Eigenschaft beim Erstellen eines neuen Produkts nicht angegeben wird, wird davon ausgegangen, dass er wahr ist. | Bool |
| subscriptionsLimit | Gibt an, ob die Anzahl der Abonnements, die ein Benutzer gleichzeitig für dieses Produkt haben kann. Wird auf NULL festgelegt oder weggelassen, um unbegrenzte Anzahl pro Benutzerabonnements zuzulassen. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist. | Int |
| Bedingungen | Produktbedingungen. Entwickler, die versuchen, das Produkt zu abonnieren, werden präsentiert und müssen diese Bedingungen akzeptieren, bevor sie den Abonnementvorgang abschließen können. | Schnur |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "Service/workspaces/products" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.ApiManagement/service/workspaces/products" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/products@2022-09-01-preview"
name = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Eigenschaftswerte
Microsoft.ApiManagement/service/workspaces/products
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst/Arbeitsbereiche |
| Eigenschaften | Vertragseigenschaften für Produktentität. | ProductContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/workspaces/products@2022-09-01-preview" |
ProductContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| approvalRequired | gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn "false" lautet, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren aufrufen können. Wenn dies der Fall ist, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler die APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist. | Bool |
| Beschreibung | Produktbeschreibung. Kann HTML-Formatierungstags enthalten. | Schnur Zwänge: Max. Länge = |
| displayName | Produktname. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Zustand | ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte sind von Benutzern des Entwicklerportals auffindbar. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nicht veröffentlicht. | "notPublished" "veröffentlicht" |
| subscriptionRequired | Gibt an, ob für den Zugriff auf in diesem Produkt enthaltene APIs ein Produktabonnement erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, um eine Anforderung an eine IM Produkt enthaltene API auszuführen. Wenn falsch, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine API, die im Produkt enthalten ist, können ohne Abonnementschlüssel erfolgen. Wenn die Eigenschaft beim Erstellen eines neuen Produkts nicht angegeben wird, wird davon ausgegangen, dass er wahr ist. | Bool |
| subscriptionsLimit | Gibt an, ob die Anzahl der Abonnements, die ein Benutzer gleichzeitig für dieses Produkt haben kann. Wird auf NULL festgelegt oder weggelassen, um unbegrenzte Anzahl pro Benutzerabonnements zuzulassen. Kann nur vorhanden sein, wenn "subscriptionRequired"-Eigenschaft vorhanden ist und den Wert "false" aufweist. | Int |
| Bedingungen | Produktbedingungen. Entwickler, die versuchen, das Produkt zu abonnieren, werden präsentiert und müssen diese Bedingungen akzeptieren, bevor sie den Abonnementvorgang abschließen können. | Schnur |