Freigeben über

Microsoft.ApiManagement service/subscriptions 2023-03-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 unter Änderungsprotokoll.

Ressourcenformat

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

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

Eigenschaftswerte

Microsoft.ApiManagement/service/subscriptions

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Max. Länge =
Pattern = ^[^*#&+:<>?]+$ (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-
Eigenschaften Abonnementvertragseigenschaften. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Name Beschreibung Wert
allowTracing Bestimmt, ob die Ablaufverfolgung aktiviert werden kann Bool
displayName Abonnementname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
ownerId Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird Schnur
primaryKey Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Umfang Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. Zeichenfolge (erforderlich)
secondaryKey Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Zustand 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, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert. "aktiv"
"abgebrochen"
"abgelaufen"
"abgelehnt"
"übermittelt"
"angehalten"

ARM-Vorlagenressourcendefinition

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 unter Änderungsprotokoll.

Ressourcenformat

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

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

Eigenschaftswerte

Microsoft.ApiManagement/service/subscriptions

Name Beschreibung Wert
apiVersion Die API-Version "2023-03-01-preview"
Name Der Ressourcenname Schnur

Zwänge:
Max. Länge =
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Eigenschaften Abonnementvertragseigenschaften. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/subscriptions"

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Name Beschreibung Wert
allowTracing Bestimmt, ob die Ablaufverfolgung aktiviert werden kann Bool
displayName Abonnementname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
ownerId Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird Schnur
primaryKey Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Umfang Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. Zeichenfolge (erforderlich)
secondaryKey Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Zustand 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, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert. "aktiv"
"abgebrochen"
"abgelaufen"
"abgelehnt"
"übermittelt"
"angehalten"

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 unter Änderungsprotokoll.

Ressourcenformat

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

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

Eigenschaftswerte

Microsoft.ApiManagement/service/subscriptions

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Max. Länge =
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Abonnementvertragseigenschaften. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview"

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Name Beschreibung Wert
allowTracing Bestimmt, ob die Ablaufverfolgung aktiviert werden kann Bool
displayName Abonnementname. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
ownerId Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird Schnur
primaryKey Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Umfang Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. Zeichenfolge (erforderlich)
secondaryKey Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Zustand 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, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert. "aktiv"
"abgebrochen"
"abgelaufen"
"abgelehnt"
"übermittelt"
"angehalten"