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=2022-08-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2022-08-01&appType={appType}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. RegEx-Muster: |
sid
|
path | True |
string |
Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in API Management dar. RegEx-Muster: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
app
|
query |
Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyherausgeberportal. |
||
notify
|
query |
boolean |
Benachrichtigen der Änderung im Abonnementstatus.
|
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
If-Match |
string |
ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
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 im Format /users/{userId} erstellt wird |
|
properties.primaryKey |
string |
Primärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben wird, wird der Schlüssel automatisch generiert. |
|
properties.secondaryKey |
string |
Sekundärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben wird, wird der Schlüssel automatisch generiert. |
|
properties.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. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Benutzer hat das Produkt bereits abonniert. Header ETag: string |
|
201 Created |
Der Benutzer wurde erfolgreich für das Produkt abonniert. Header ETag: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementCreateSubscription
Beispielanforderung
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2022-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"
}
}
Beispiel für eine Antwort
{
"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
Name | Beschreibung |
---|---|
App |
Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyherausgeberportal. |
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Subscription |
Abonnementdetails. |
Subscription |
Details zum Erstellen eines Abonnements. |
Subscription |
Abonnementstatus. 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. |
AppType
Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyherausgeberportal.
Name | Typ | Beschreibung |
---|---|---|
developerPortal |
string |
Die Benutzererstellungsanforderung wurde vom neuen Entwicklerportal gesendet. |
portal |
string |
Die Benutzererstellungsanforderung wurde vom Legacy-Entwicklerportal gesendet. |
ErrorFieldContract
Fehlerfeldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
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 im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
SubscriptionContract
Abonnementdetails.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/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: |
properties.displayName |
string |
Der Name des Abonnements oder NULL, wenn das Abonnement keinen Namen hat. |
properties.endDate |
string |
Datum, an dem das Abonnement gekündigt wurde oder abgelaufen ist. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch gekündigt. Der Abonnementlebenszyklus kann mithilfe der |
properties.expirationDate |
string |
Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der |
properties.notificationDate |
string |
Benachrichtigungsdatum des bevorstehenden Abonnementablaufs. Das Datum entspricht dem folgenden Format: |
properties.ownerId |
string |
Die Benutzer-ID des Abonnementeigentümers. Der Wert ist eine gültige relative URL im Format "/users/{userId}", wobei {userId} ein Benutzerbezeichner ist. |
properties.primaryKey |
string |
Primärschlüssel des Abonnements. Diese Eigenschaft wird bei "GET"-Vorgängen nicht 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 bei "GET"-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. |
properties.startDate |
string |
Abonnementaktivierungsdatum. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der |
properties.state |
Abonnementstatus. 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. |
|
properties.stateComment |
string |
Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wird, wenn der Status in "abgelehnt" geändert wird. |
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
SubscriptionCreateParameters
Details zum Erstellen eines Abonnements.
Name | Typ | Beschreibung |
---|---|---|
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 im Format /users/{userId} erstellt wird |
properties.primaryKey |
string |
Primärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben wird, wird der Schlüssel automatisch generiert. |
properties.scope |
string |
Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. |
properties.secondaryKey |
string |
Sekundärer Abonnementschlüssel. Wenn während der Anforderung nicht angegeben wird, wird der Schlüssel automatisch generiert. |
properties.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. |
SubscriptionState
Abonnementstatus. 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.
Name | Typ | Beschreibung |
---|---|---|
active |
string |
|
cancelled |
string |
|
expired |
string |
|
rejected |
string |
|
submitted |
string |
|
suspended |
string |