Workspace Subscription - Create Or Update

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Vytvoří nebo aktualizuje předplatné zadaného uživatele na zadaný produkt.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?api-version=2024-05-01

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identifikátor pracovního prostoru V aktuální instanci služby API Management musí být jedinečné.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
appType	query		AppType	Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu vydavatele.
notify	query		boolean	Upozorněte změnu ve stavu předplatného. Pokud je false, neodesílejte žádné e-mailové oznámení o změně stavu předplatného. Pokud je pravda, odešlete e-mailové oznámení o změně stavu předplatného.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	ETag of the Entity. Při vytváření entity se nevyžaduje, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.displayName	True	string minLength: 1 maxLength: 100	Název předplatného
properties.scope	True	string	Rozsah, například /products/{productId} nebo /apis nebo /apis/{apiId}.
properties.allowTracing		boolean	Určuje, jestli je možné povolit trasování.
properties.ownerId		string	Uživatel (cesta ID uživatele), pro kterého se předplatné vytváří ve formuláři /users/{userId}
properties.primaryKey		string minLength: 1 maxLength: 256	Primární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky.
properties.secondaryKey		string minLength: 1 maxLength: 256	Sekundární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky.
properties.state		SubscriptionState	Počáteční stav předplatného Pokud není zadána žádná hodnota, předplatné se vytvoří se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

Odpovědi

Name	Typ	Description
200 OK	SubscriptionContract	Uživatel se už přihlásil k odběru produktu. Hlavičky ETag: string
201 Created	SubscriptionContract	Uživatel se úspěšně přihlásil k odběru produktu. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

SubscriptionContract

Uživatel se už přihlásil k odběru produktu.

Hlavičky

ETag: string

201 Created

SubscriptionContract

Uživatel se úspěšně přihlásil k odběru produktu.

Hlavičky

ETag: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementCreateWorkspaceSubscription

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub?api-version=2024-05-01

{
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Ukázková odpověď

Stavový kód:: 201

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

Stavový kód:: 200

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

Definice

Name	Description
AppType	Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
SubscriptionContract	Podrobnosti předplatného
SubscriptionCreateParameters	Podrobnosti o vytvoření předplatného
SubscriptionState	Stav předplatného Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

AppType

Výčet

Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu.

Hodnota	Description
portal	Žádost o vytvoření uživatele odeslala starší verze portálu pro vývojáře.
developerPortal	Žádost o vytvoření uživatele odeslal nový portál pro vývojáře.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

SubscriptionContract

Objekt

Podrobnosti předplatného

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.allowTracing	boolean	Určuje, jestli je povolené trasování.
properties.createdDate	string (date-time)	Datum vytvoření předplatného Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.displayName	string minLength: 0 maxLength: 100	Název předplatného nebo hodnota null, pokud předplatné nemá žádné jméno.
properties.endDate	string (date-time)	Datum zrušení předplatného nebo vypršení jeho platnosti Nastavení je určené jenom pro účely auditu a předplatné se automaticky nezruší. Životní cyklus předplatného je možné spravovat pomocí vlastnosti `state`. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.expirationDate	string (date-time)	Datum vypršení platnosti předplatného Nastavení je určené jenom pro účely auditu a předplatné nevypršelo automaticky. Životní cyklus předplatného je možné spravovat pomocí vlastnosti `state`. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.notificationDate	string (date-time)	Nadcházející datum oznámení o vypršení platnosti předplatného Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.ownerId	string	Identifikátor prostředku uživatele vlastníka předplatného. Hodnota je platná relativní adresa URL ve formátu /users/{userId}, kde {userId} je identifikátor uživatele.
properties.primaryKey	string minLength: 1 maxLength: 256	Primární klíč předplatného. Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets.
properties.scope	string	Rozsah, například /products/{productId} nebo /apis nebo /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Sekundární klíč předplatného Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets.
properties.startDate	string (date-time)	Datum aktivace předplatného. Nastavení je určené jenom pro účely auditu a předplatné se neaktivuje automaticky. Životní cyklus předplatného je možné spravovat pomocí vlastnosti `state`. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.state	SubscriptionState	Stav předplatného Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.
properties.stateComment	string	Volitelný komentář k předplatnému přidaný správcem, když se stav změní na odmítnutý.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SubscriptionCreateParameters

Objekt

Podrobnosti o vytvoření předplatného

Name	Typ	Description
properties.allowTracing	boolean	Určuje, jestli je možné povolit trasování.
properties.displayName	string minLength: 1 maxLength: 100	Název předplatného
properties.ownerId	string	Uživatel (cesta ID uživatele), pro kterého se předplatné vytváří ve formuláři /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Primární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky.
properties.scope	string	Rozsah, například /products/{productId} nebo /apis nebo /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Sekundární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky.
properties.state	SubscriptionState	Počáteční stav předplatného Pokud není zadána žádná hodnota, předplatné se vytvoří se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

SubscriptionState

Výčet

Stav předplatného Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

Hodnota	Description
suspended
active
expired
submitted
rejected
cancelled

Sdílet prostřednictvím

Workspace Subscription - Create Or Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementCreateWorkspaceSubscription

Ukázkový požadavek

Ukázková odpověď

Definice

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState