Freigeben über

Microsoft.ApiManagement service/subscriptions 2021-12-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp "Dienst/Abonnements" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/subscriptions-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Eigenschaftswerte

service/subscriptions

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 Abonnementvertragseigenschaften. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Name BESCHREIBUNG Wert
allowTracing Bestimmt, ob die Ablaufverfolgung aktiviert werden kann. bool
displayName Abonnementname. Zeichenfolge (erforderlich)
ownerId Benutzer (Benutzer-ID-Pfad), für den das Abonnement im Format /users/{userId} erstellt wird Zeichenfolge
primaryKey Primärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben, wird der Schlüssel automatisch generiert. Zeichenfolge
scope Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. Zeichenfolge (erforderlich)
secondaryKey Sekundärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben, wird der Schlüssel automatisch generiert. Zeichenfolge
state Anfänglicher Abonnementstatus. Wenn kein Wert angegeben wird, wird das Abonnement mit dem Status Übermittelt erstellt. Mögliche Status sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen: Das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert. "aktiv"
"abgebrochen"
"abgelaufen"
"abgelehnt"
"übermittelt"
"angehalten"

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp "Dienst/Abonnements" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/subscriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

Eigenschaftswerte

service/subscriptions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/subscriptions"
apiVersion Die Version der Ressourcen-API "2021-12-01-preview"
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties Abonnementvertragseigenschaften. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Name BESCHREIBUNG Wert
allowTracing Bestimmt, ob die Ablaufverfolgung aktiviert werden kann. bool
displayName Abonnementname. Zeichenfolge (erforderlich)
ownerId Benutzer (Benutzer-ID-Pfad), für den das Abonnement im Format /users/{userId} erstellt wird Zeichenfolge
primaryKey Primärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben, wird der Schlüssel automatisch generiert. Zeichenfolge
scope Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. Zeichenfolge (erforderlich)
secondaryKey Sekundärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben, wird der Schlüssel automatisch generiert. Zeichenfolge
state Anfänglicher Abonnementstatus. Wenn kein Wert angegeben wird, wird das Abonnement mit dem Status Übermittelt erstellt. Mögliche Status sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen: Das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert. "aktiv"
"abgebrochen"
"abgelaufen"
"abgelehnt"
"übermittelt"
"angehalten"

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Dienst/Abonnements" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/subscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

Eigenschaftswerte

service/subscriptions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/subscriptions@2021-12-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 das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties Abonnementvertragseigenschaften. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Name BESCHREIBUNG Wert
allowTracing Bestimmt, ob die Ablaufverfolgung aktiviert werden kann. bool
displayName Abonnementname. Zeichenfolge (erforderlich)
ownerId Benutzer (Benutzer-ID-Pfad), für den das Abonnement im Format /users/{userId} erstellt wird Zeichenfolge
primaryKey Primärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben, wird der Schlüssel automatisch generiert. Zeichenfolge
scope Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. Zeichenfolge (erforderlich)
secondaryKey Sekundärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben, wird der Schlüssel automatisch generiert. Zeichenfolge
state Anfänglicher Abonnementstatus. Wenn kein Wert angegeben ist, wird das Abonnement mit dem Status Übermittelt erstellt. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert. "aktiv"
"abgebrochen"
"abgelaufen"
"abgelehnt"
"übermittelt"
"angehalten"