OriginsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:origins> attribute.
- Inheritance
-
builtins.objectOriginsOperations
Constructor
OriginsOperations(*args, **kwargs)
Methods
begin_create |
Creates a new origin within the specified endpoint. |
begin_delete |
Deletes an existing origin within an endpoint. |
begin_update |
Updates an existing origin within an endpoint. |
get |
Gets an existing origin within an endpoint. |
list_by_endpoint |
Lists all of the existing origins within an endpoint. |
begin_create
Creates a new origin within the specified endpoint.
begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, origin: _models.Origin, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Origin]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
profile_name
Required
|
Name of the CDN profile which is unique within the resource group. Required. |
endpoint_name
Required
|
Name of the endpoint under the profile which is unique globally. Required. |
origin_name
Required
|
Name of the origin that is unique within the endpoint. Required. |
origin
Required
|
Origin properties. Is either a Origin type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Origin or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes an existing origin within an endpoint.
begin_delete(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
profile_name
Required
|
Name of the CDN profile which is unique within the resource group. Required. |
endpoint_name
Required
|
Name of the endpoint under the profile which is unique globally. Required. |
origin_name
Required
|
Name of the origin which is unique within the endpoint. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update
Updates an existing origin within an endpoint.
begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, origin_update_properties: _models.OriginUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Origin]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
profile_name
Required
|
Name of the CDN profile which is unique within the resource group. Required. |
endpoint_name
Required
|
Name of the endpoint under the profile which is unique globally. Required. |
origin_name
Required
|
Name of the origin which is unique within the endpoint. Required. |
origin_update_properties
Required
|
Origin properties. Is either a OriginUpdateParameters type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Origin or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets an existing origin within an endpoint.
get(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, **kwargs: Any) -> Origin
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
profile_name
Required
|
Name of the CDN profile which is unique within the resource group. Required. |
endpoint_name
Required
|
Name of the endpoint under the profile which is unique globally. Required. |
origin_name
Required
|
Name of the origin which is unique within the endpoint. Required. |
Returns
Type | Description |
---|---|
Origin or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_endpoint
Lists all of the existing origins within an endpoint.
list_by_endpoint(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> Iterable[Origin]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
profile_name
Required
|
Name of the CDN profile which is unique within the resource group. Required. |
endpoint_name
Required
|
Name of the endpoint under the profile which is unique globally. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Origin or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.cdn.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>
Azure SDK for Python