Subscription - Create Or Update

  • Referens
Service:
API Management
API Version:
2022-08-01

Skapar eller uppdaterar prenumerationen för den angivna användaren till den angivna produkten.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2022-08-01
With optional parameters: 
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-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

Namnet på API Management-tjänsten.

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

string

Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.

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

string

ID för målprenumerationen.
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.
appType
 query

AppType

Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är äldre utgivarportal.
notify
 query

boolean

Meddela ändring i prenumerationstillstånd.

  • Om det är falskt ska du inte skicka något e-postmeddelande för ändring av prenumerationens tillstånd
  • Om det är sant skickar du ett e-postmeddelande om ändring av prenumerationens tillstånd

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name Obligatorisk Typ Description
properties.displayName True

string

Prenumerationsnamn.
properties.scope True

string

Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.allowTracing

boolean

Avgör om spårning kan aktiveras
properties.ownerId

string

Användare (sökväg till användar-ID) för vilken prenumerationen skapas i formulär /users/{userId}
properties.primaryKey

string

Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.
properties.secondaryKey

string

Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.
properties.state

SubscriptionState

Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickad. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.

Svar

Name Typ Description
200 OK

SubscriptionContract

Användaren prenumererar redan på produkten.

Headers

ETag: string
201 Created

SubscriptionContract

Användaren prenumererade på produkten.

Headers

ETag: string
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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 personifiera ditt användarkonto

Exempel

ApiManagementCreateSubscription

Sample Request

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"
  }
}

Sample Response

Status code:
201 
{
  "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"
  }
}
Status code:
200 
{
  "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"
  }
}

Definitioner

Name Description
AppType

Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är äldre utgivarportal.
ErrorFieldContract

Fel Fältkontrakt.
ErrorResponse

Felsvar.
SubscriptionContract

Prenumerationsinformation.
SubscriptionCreateParameters

Information om prenumerationsskapande.
SubscriptionState

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.

AppType

Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är äldre utgivarportal.

Name Typ Description
developerPortal

string

Begäran om användarskapande skickades av den nya utvecklarportalen.
portal

string

Begäran om användarskapande skickades av den äldre utvecklarportalen.

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.
message

string

Mänsklig läsbar representation av fel på egenskapsnivå.
target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message

string

Mänsklig läsbar representation av felet.

SubscriptionContract

Prenumerationsinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.allowTracing

boolean

Avgör om spårning är aktiverat
properties.createdDate

string

Skapandedatum för prenumeration. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.displayName

string

Namnet på prenumerationen eller null om prenumerationen inte har något namn.
properties.endDate

string

Datum då prenumerationen avbröts eller upphörde att gälla. Inställningen är endast i granskningssyfte och prenumerationen avbryts inte automatiskt. Prenumerationens livscykel kan hanteras med hjälp state av egenskapen . Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.expirationDate

string

Prenumerationens förfallodatum. Inställningen är endast i granskningssyfte och prenumerationen upphör inte att gälla automatiskt. Prenumerationens livscykel kan hanteras med hjälp state av egenskapen . Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.notificationDate

string

Förfallodatum för kommande prenumeration. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.ownerId

string

Användarens resurs-ID för prenumerationsägaren. Värdet är en giltig relativ URL i formatet /users/{userId} där {userId} är en användaridentifierare.
properties.primaryKey

string

Prenumerationens primärnyckel. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
properties.scope

string

Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.secondaryKey

string

Prenumerationens sekundära nyckel. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
properties.startDate

string

Aktiveringsdatum för prenumeration. Inställningen är endast i granskningssyfte och prenumerationen aktiveras inte automatiskt. Prenumerationens livscykel kan hanteras med hjälp state av egenskapen . Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.state

SubscriptionState

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.
properties.stateComment

string

Valfri prenumerationskommentation som läggs till av en administratör när tillståndet ändras till "avvisad".
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Information om prenumerationsskapande.

Name Typ Description
properties.allowTracing

boolean

Avgör om spårning kan aktiveras
properties.displayName

string

Prenumerationsnamn.
properties.ownerId

string

Användare (sökväg till användar-ID) för vilken prenumerationen skapas i formulär /users/{userId}
properties.primaryKey

string

Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.
properties.scope

string

Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.secondaryKey

string

Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.
properties.state

SubscriptionState

Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickad. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.

SubscriptionState

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.

Name Typ Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string