Freigeben über

Microsoft.ApiManagement service/workspaces/subscriptions 2023-03-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp Dienst/Arbeitsbereiche/Abonnements kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:

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

Ressourcenformat

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

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

Eigenschaftswerte

Dienst/Arbeitsbereiche/Abonnements

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 Zeichenfolge (erforderlich)
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: Arbeitsbereiche
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, 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, 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"

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp Dienst/Arbeitsbereiche/Abonnements kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:

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

Ressourcenformat

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

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

Eigenschaftswerte

Dienst/Arbeitsbereiche/Abonnements

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/workspaces/subscriptions"
apiVersion Die Ressourcen-API-Version '2023-03-01-preview'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)
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, 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, 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"

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp Dienst/Arbeitsbereiche/Abonnements 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/workspaces/subscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-03-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

Dienst/Arbeitsbereiche/Abonnements

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-03-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Arbeitsbereiche
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, 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, 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"