Subscription - Create Or Update

Erstellt oder aktualisiert das Abonnement des angegebenen Benutzers für das angegebene Produkt

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2021-08-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2021-08-01&appType={appType}

URI-Parameter

Name In Required Type Description
resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

serviceName
path True
  • string

Der Name des API Management Diensts.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

sid
path True
  • string

Entitätsbezeichner des Abonnements. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in API Management dar.

Regex pattern: ^[^*#&+:<>?]+$

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die Microsoft Azure Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

appType
query

Bestimmt den Anwendungstyp, der die Anforderung für den Erstellen von Benutzern sendet. Der Standardwert ist das Legacy-Herausgeberportal.

notify
query
  • boolean

Änderung im Abonnementstatus benachrichtigen.

  • Wenn falsch, senden Sie keine E-Mail-Benachrichtigung zum Ändern des Status des Abonnements
  • Wenn true, senden Sie E-Mail-Benachrichtigungen über den Status des Abonnements

Anforderungsheader

Name Required Type Description
If-Match
  • string

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name Required Type Description
properties.displayName True
  • string

Abonnementname.

properties.scope True
  • string

Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.

properties.allowTracing
  • boolean

Bestimmt, ob die Ablaufverfolgung aktiviert werden kann

properties.ownerId
  • string

Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird

properties.primaryKey
  • string

Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert.

properties.secondaryKey
  • string

Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert.

properties.state

Anfangsabonnementstatus. 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 ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * storniert – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement erreichte sein Ablaufdatum und wurde deaktiviert.

Antworten

Name Type Description
200 OK

Der Benutzer hat das Produkt bereits abonniert.

Headers

  • ETag: string
201 Created

Der Benutzer wurde erfolgreich für das Produkt abonniert.

Headers

  • ETag: string
Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementCreateSubscription

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2021-08-01

{
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definitionen

AppType

Bestimmt den Anwendungstyp, der die Anforderung für den Erstellen von Benutzern sendet. Der Standardwert ist das Legacy-Herausgeberportal.

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

SubscriptionContract

Abonnementdetails.

SubscriptionCreateParameters

Abonnementdetails erstellen.

SubscriptionState

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * storniert – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement erreichte sein Ablaufdatum und wurde deaktiviert.

AppType

Bestimmt den Anwendungstyp, der die Anforderung für den Erstellen von Benutzern sendet. Der Standardwert ist das Legacy-Herausgeberportal.

Name Type Description
developerPortal
  • string

Benutzererstellungsanfrage wurde vom neuen Entwicklerportal gesendet.

portal
  • string

Benutzererstellungsanfrage wurde vom Legacyentwicklerportal gesendet.

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.

message
  • string

Humanlesbare Darstellung des Fehlers auf Eigenschaftsebene.

target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

Die Liste der ungültigen Felder, die in Anforderung gesendet werden, im Falle eines Überprüfungsfehlers.

error.message
  • string

Lesbare Darstellung des Fehlers.

SubscriptionContract

Abonnementdetails.

Name Type Description
id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Der Name der Ressource

properties.allowTracing
  • boolean

Bestimmt, ob die Ablaufverfolgung aktiviert ist

properties.createdDate
  • string

Erstellungsdatum des Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ wie durch den ISO 8601-Standard angegeben.

properties.displayName
  • string

Der Name des Abonnements oder null, wenn das Abonnement keinen Namen hat.

properties.endDate
  • string

Datum, an dem das Abonnement storniert oder abgelaufen ist. Die Einstellung gilt nur für Überwachungszwecke, und das Abonnement wird nicht automatisch abgebrochen. Der Abonnementlebenszyklus kann mithilfe der state Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ wie durch den ISO 8601-Standard angegeben.

properties.expirationDate
  • string

Ablaufdatum des Abonnements. Die Einstellung gilt nur für Überwachungszwecke, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der state Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ wie durch den ISO 8601-Standard angegeben.

properties.notificationDate
  • string

Ablaufdatum des bevorstehenden Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ wie durch den ISO 8601-Standard angegeben.

properties.ownerId
  • string

Die Benutzer-ID des Abonnementeigentümers. Der Wert ist eine gültige relative URL im Format von /users/{userId}, wobei {userId} ein Benutzerbezeichner ist.

properties.primaryKey
  • string

Primärschlüssel des Abonnements. Diese Eigenschaft wird nicht für "GET"-Vorgänge ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

properties.scope
  • string

Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.

properties.secondaryKey
  • string

Sekundärer Abonnementschlüssel. Diese Eigenschaft wird nicht für "GET"-Vorgänge ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

properties.startDate
  • string

Abonnementaktivierungsdatum. Die Einstellung gilt nur für Überwachungszwecke, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der state Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ wie durch den ISO 8601-Standard angegeben.

properties.state

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * storniert – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement erreichte sein Ablaufdatum und wurde deaktiviert.

properties.stateComment
  • string

Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wurde, wenn der Zustand in "abgelehnt" geändert wird.

type
  • string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft. Storage/storageAccounts"

SubscriptionCreateParameters

Abonnementdetails erstellen.

Name Type Description
properties.allowTracing
  • boolean

Bestimmt, ob die Ablaufverfolgung aktiviert werden kann

properties.displayName
  • string

Abonnementname.

properties.ownerId
  • string

Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird

properties.primaryKey
  • string

Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert.

properties.scope
  • string

Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.

properties.secondaryKey
  • string

Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert.

properties.state

Anfangsabonnementstatus. 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 ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * storniert – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement erreichte sein Ablaufdatum und wurde deaktiviert.

SubscriptionState

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * storniert – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement erreichte sein Ablaufdatum und wurde deaktiviert.

Name Type Description
active
  • string
cancelled
  • string
expired
  • string
rejected
  • string
submitted
  • string
suspended
  • string