Subscription interface
Interfejs reprezentujący subskrypcję.
Metody
Szczegóły metody
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje subskrypcję określonego użytkownika do określonego produktu.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- parameters
- SubscriptionCreateParameters
Utwórz parametry.
Parametry opcji.
Zwraca
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Usuwa określoną subskrypcję.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- options
- SubscriptionDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Pobiera określoną jednostkę Subskrypcja.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- options
- SubscriptionGetOptionalParams
Parametry opcji.
Zwraca
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) subskrypcji apimanagement określonej przez jej identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Wyświetla listę wszystkich subskrypcji wystąpienia usługi API Management.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- options
- SubscriptionListOptionalParams
Parametry opcji.
Zwraca
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Pobiera określone klucze subskrypcji.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Ponownie generuje klucz podstawowy istniejącej subskrypcji wystąpienia usługi API Management.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Ponownie generuje klucz pomocniczy istniejącej subskrypcji wystąpienia usługi API Management.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Aktualizuje szczegóły subskrypcji określonej przez jej identyfikator.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- SubscriptionUpdateParameters
Aktualizuj parametry.
- options
- SubscriptionUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<SubscriptionUpdateResponse>